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
28 import javax.annotation.Nonnull;
29 import java.io.PrintWriter;
30
31 /***************************************************************************************************************************************************************
32 *
33 * The role of an object that can be rendered into a {@link String} as plain text. Note that while it has a method
34 * with the same signature as {@link StringRenderable}, it has modified semantics since it guarantees that the returned
35 * string is a plain text.
36 *
37 * @stereotype Role
38 *
39 * @author Fabrizio Giudici
40 *
41 **************************************************************************************************************************************************************/
42 @FunctionalInterface
43 public interface PlainTextRenderable extends StringRenderable
44 {
45 public static final Class<PlainTextRenderable> _PlainTextRenderable_ = PlainTextRenderable.class;
46
47 /***********************************************************************************************************************************************************
48 *
49 * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
50 **********************************************************************************************************************************************************/
51 public default void renderTo (@Nonnull final StringBuilder stringBuilder,
52 @Nonnull final Object ... args)
53 {
54 stringBuilder.append(render(args));
55 }
56
57 /***********************************************************************************************************************************************************
58 *
59 * @since 3.2-ALPHA-1 (was previously on {@code Feedback8}
60 **********************************************************************************************************************************************************/
61 public default void renderTo (@Nonnull final PrintWriter printWriter,
62 @Nonnull final Object ... args)
63 {
64 printWriter.print(render(args));
65 }
66 }