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 - 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 HTML markup.
34: *
35: * @stereotype Role
36: *
37: * @author Fabrizio Giudici
38: *
39: **************************************************************************************************************************************************************/
40: @FunctionalInterface
41: public interface StringRenderable
42: {
43: public static final Class<StringRenderable> _StringRenderable_ = StringRenderable.class;
44:
45: /***********************************************************************************************************************************************************
46: * Renders the attached object into a {@link String}. The method accepts optional parameters that can be used to
47: * control the format of the rendering; they are usually specific of the object attached to this role.
48: *
49: * @param args optional rendering parameters
50: * @return the string
51: **********************************************************************************************************************************************************/
52: @Nonnull
53: public String render (@Nonnull Object ... args);
54:
55: /***********************************************************************************************************************************************************
56: * Renders the attached object appending to a {@link StringBuilder}. The method accepts optional parameters that can
57: * be used to control the format of the rendering; they are usually specific of the object attached to this role.
58: *
59: * @param stringBuilder the {@code StringBuilder} to append to
60: * @param args optional rendering parameters
61: **********************************************************************************************************************************************************/
62: public default void renderTo (@Nonnull final StringBuilder stringBuilder, @Nonnull final Object ... args)
63: {
64: stringBuilder.append(render(args));
65: }
66:
67: /***********************************************************************************************************************************************************
68: * Renders the attached object printing to a {@link PrintWriter}. The method accepts optional parameters that can
69: * be used to control the format of the rendering; they are usually specific of the object attached to this role.
70: *
71: * @param printWriter the {@code PrintWriter} to print to
72: * @param args optional rendering parameters
73: **********************************************************************************************************************************************************/
74: public default void renderTo (@Nonnull final PrintWriter printWriter, @Nonnull final Object ... args)
75: {
76: printWriter.print(render(args));
77: } }