PlainTextRenderable.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2024 by Tidalwave s.a.s. (http://tidalwave.it)
  8.  *
  9.  * *************************************************************************************************************************************************************
  10.  *
  11.  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
  12.  * You may obtain a copy of the License at
  13.  *
  14.  *     http://www.apache.org/licenses/LICENSE-2.0
  15.  *
  16.  * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  17.  * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
  18.  *
  19.  * *************************************************************************************************************************************************************
  20.  *
  21.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  22.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  23.  *
  24.  * *************************************************************************************************************************************************************
  25.  */
  26. package it.tidalwave.role;

  27. import javax.annotation.Nonnull;
  28. import java.io.PrintWriter;

  29. /***************************************************************************************************************************************************************
  30.  *
  31.  * The role of an object that can be rendered into a {@link String} as plain text. Note that while it has a method
  32.  * with the same signature as {@link StringRenderable}, it has modified semantics since it guarantees that the returned
  33.  * string is a plain text.
  34.  *
  35.  * @stereotype Role
  36.  *
  37.  * @author  Fabrizio Giudici
  38.  *
  39.  **************************************************************************************************************************************************************/
  40. @FunctionalInterface
  41. public interface PlainTextRenderable extends StringRenderable
  42.   {
  43.     public static final Class<PlainTextRenderable> _PlainTextRenderable_ = PlainTextRenderable.class;

  44.     /***********************************************************************************************************************************************************
  45.      *
  46.      * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
  47.      **********************************************************************************************************************************************************/
  48.     public default void renderTo (@Nonnull final StringBuilder stringBuilder,
  49.                                   @Nonnull final Object ... args)
  50.       {
  51.         stringBuilder.append(render(args));
  52.       }

  53.     /***********************************************************************************************************************************************************
  54.      *
  55.      * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
  56.      **********************************************************************************************************************************************************/
  57.     public default void renderTo (@Nonnull final PrintWriter printWriter,
  58.                                   @Nonnull final Object ... args)
  59.       {
  60.         printWriter.print(render(args));
  61.       }
  62.   }