Package: StringRenderable

StringRenderable

name	instruction	branch	complexity	line	method
renderTo(PrintWriter, Object[])	M: 6 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 2 C: 0 0%	M: 1 C: 0 0%
renderTo(StringBuilder, Object[])	M: 7 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 2 C: 0 0%	M: 1 C: 0 0%
static {...}	M: 3 C: 0 0%	M: 0 C: 0 100%	M: 1 C: 0 0%	M: 1 C: 0 0%	M: 1 C: 0 0%

Coverage

1: /*
2: * *********************************************************************************************************************
3: *
4: * TheseFoolishThings: Miscellaneous utilities
5: * http://tidalwave.it/projects/thesefoolishthings
6: *
7: * Copyright (C) 2009 - 2023 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
12: * the License. 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
17: * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations under the License.
19: *
20: * *********************************************************************************************************************
21: *
22: * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
23: * git clone https://github.com/tidalwave-it/thesefoolishthings-src
24: *
25: * *********************************************************************************************************************
26: */
27: package it.tidalwave.role;
28:
29: import javax.annotation.Nonnull;
30: import java.io.PrintWriter;
31:
32: /***********************************************************************************************************************
33: *
34: * The role of an object that can be rendered into a {@link String} as HTML markup.
35: *
36: * @stereotype Role
37: *
38: * @author Fabrizio Giudici
39: *
40: **********************************************************************************************************************/
41: @FunctionalInterface
42: public interface StringRenderable
43: {
44: public static final Class<StringRenderable> _StringRenderable_ = StringRenderable.class;
45:
46: /*******************************************************************************************************************
47: *
48: * Renders the attached object into a {@link String}. The method accepts optional parameters that can be used to
49: * control the format of the rendering; they are usually specific of the object attached to this role.
50: *
51: * @param args optional rendering parameters
52: * @return the string
53: *
54: ******************************************************************************************************************/
55: @Nonnull
56: public String render (@Nonnull Object ... args);
57:
58: /*******************************************************************************************************************
59: *
60: * Renders the attached object appending to a {@link StringBuilder}. The method accepts optional parameters that can
61: * be used to control the format of the rendering; they are usually specific of the object attached to this role.
62: *
63: * @param stringBuilder the {@code StringBuilder} to append to
64: * @param args optional rendering parameters
65: *
66: ******************************************************************************************************************/
67: public default void renderTo (@Nonnull final StringBuilder stringBuilder, @Nonnull final Object ... args)
68: {
69: stringBuilder.append(render(args));
70: }
71:
72: /*******************************************************************************************************************
73: *
74: * Renders the attached object printing to a {@link PrintWriter}. The method accepts optional parameters that can
75: * be used to control the format of the rendering; they are usually specific of the object attached to this role.
76: *
77: * @param printWriter the {@code PrintWriter} to print to
78: * @param args optional rendering parameters
79: *
80: ******************************************************************************************************************/
81: public default void renderTo (@Nonnull final PrintWriter printWriter, @Nonnull final Object ... args)
82: {
83: printWriter.print(render(args));
84: } }