org.ujorm.tools.msg

Class ValueFormatter

java.lang.Object

org.ujorm.tools.msg.MsgFormatter

org.ujorm.tools.msg.ValueFormatter

Direct Known Subclasses:

ValuePrinter

@Unmodifiable
public class ValueFormatter
extends MsgFormatter

Formatter of log messages where argument is located by the {} characters. See the next correct asserts:

  assertEquals("TEST"    , MsgFormatter.format("TE{}T", "S"));
  assertEquals("TE, S, T", MsgFormatter.format("TE", "S", "T"));
  assertEquals("TES{}"   , MsgFormatter.format("TE{}{}", "S"));
 

Since:

1.73

Author:

Pavel Ponec

Field Summary

Fields

Modifier and Type	Field and Description
protected String	valueBorder Border of the byte array

Fields inherited from class org.ujorm.tools.msg.MsgFormatter

DEFAULT_MARK, SEPARATOR

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ValueFormatter() Static methods are available only
protected	ValueFormatter(@NotNull String mark, @NotNull String textBorder) Static methods are available only

Method Summary

Modifier and Type	Method and Description
static <T> @NotNull String	format(@Nullable String messageTemplate, T... arguments) Format the message, see the next correct asserts: assertEquals("TEST" , MsgFormatter.format("TE{}T", "S")); assertEquals("TE, S, T", MsgFormatter.format("TE", "S", "T")); assertEquals("TES{}" , MsgFormatter.format("TE{}{}", "S"));
static <T> @NotNull String	formatSql(@Nullable String sqlTemplate, T... arguments) Format the SQL where makup character is '?'.
protected int	getSizeLimit() Default lenhth is 32
protected void	writeByteArray(@NotNull byte[] bytes, @NotNull Appendable out) Write bytes as hexa
protected void	writeLongValue(@NotNull CharSequence value, @NotNull Appendable out) You can call the method from a child class
protected void	writeValue(@Nullable Object value, @NotNull Appendable out, boolean marked) Print argument to the Writter with an optional format.

Methods inherited from class org.ujorm.tools.msg.MsgFormatter

format, format, formatMsg, formatMsg

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

valueBorder

protected final String valueBorder

Border of the byte array

Constructor Detail

ValueFormatter

protected ValueFormatter()

Static methods are available only

ValueFormatter

protected ValueFormatter(@NotNull
                         @NotNull String mark,
                         @NotNull
                         @NotNull String textBorder)

Static methods are available only

Method Detail

writeValue

protected void writeValue(@Nullable
                          @Nullable Object value,
                          @NotNull
                          @NotNull Appendable out,
                          boolean marked)
                   throws IOException

Print argument to the Writter with an optional format.

Overrides:

writeValue in class MsgFormatter

Parameters:

out - Appendable

value - A one value where the Supplier interface is supported.

Throws:

IOException

writeByteArray

protected void writeByteArray(@NotNull
                              @NotNull byte[] bytes,
                              @NotNull
                              @NotNull Appendable out)
                       throws IOException

Write bytes as hexa

Throws:

IOException

writeLongValue

protected void writeLongValue(@NotNull
                              @NotNull CharSequence value,
                              @NotNull
                              @NotNull Appendable out)
                       throws IOException

You can call the method from a child class

Throws:

IOException

getSizeLimit

protected int getSizeLimit()

Default lenhth is 32

format

@NotNull
public static <T> @NotNull String format(@Nullable
                                                  @Nullable String messageTemplate,
                                                  @Nullable
                                                  T... arguments)

Format the message, see the next correct asserts:

  assertEquals("TEST"    , MsgFormatter.format("TE{}T", "S"));
  assertEquals("TE, S, T", MsgFormatter.format("TE", "S", "T"));
  assertEquals("TES{}"   , MsgFormatter.format("TE{}{}", "S"));
 

Parameters:

messageTemplate - Template where argument position is marked by the {} characters.

arguments - Optional arguments

Returns:

formatSql

@NotNull
public static <T> @NotNull String formatSql(@Nullable
                                                     @Nullable String sqlTemplate,
                                                     @Nullable
                                                     T... arguments)

Format the SQL where makup character is '?'.

  assertEquals("TEST"    , MsgFormatter.format("TE?T", "S"));
  assertEquals("TE, S, T", MsgFormatter.format("TE", "S", "T"));
  assertEquals("TES{}"   , MsgFormatter.format("TE??", "S"));
 

Parameters:

sqlTemplate - SQL template where argument position is marked by the '?' characters.

arguments - Optional arguments

Returns: