org.nerd4j.utils.lang

Interface ToString.Configurator

Enclosing class:

ToString

public static interface ToString.Configurator

Implementation of the Pattern Builder with the purpose to properly create a ToString.Configuration.

Since:

2.0.0

Author:

Massimo Coluzzi

Method Summary

Modifier and Type	Method and Description
String	like(ToString.Printer printer) Creates the ToString.Configuration and invokes the provided ToString.Printer in order to build the requested String representation.
String	likeEclipse() Creates an output of the method Object.toString() like the one generated by the Eclipse IDE.
String	likeFunction() Creates an output of the method Object.toString() in the form of a function, where the function name is the target class name and the given fields are listed as the function arguments.
String	likeIntellij() Creates an output of the method Object.toString() like the one generated by the IntelliJ IDE.
String	likeTuple() Creates an output of the method Object.toString() in the form of a tuple, optionally preceded by the class name.
ToString.Configurator	print(Object... values) Adds the given list of values as unnamed Fields in the resulting ToString.Configuration.
ToString.Configurator	print(String name, Object value) Adds the given <name,value> pair as a named Field in the resulting ToString.Configuration.
String	using(String prefix, String fieldSeparator, String suffix) This is a convenience method.
String	using(String prefix, String nameValueSeparator, String fieldSeparator, String suffix) Creates an output of the method Object.toString() using the given prefix and suffix and using the given separators.
ToString.Configurator	withCustomClassName(String value) Tells the ToString class to print the given text instead of the class name.
ToString.Configurator	withFullClassName() Tells the ToString class to print the full qualified class name.
ToString.Configurator	withNoClassName() Tells the ToString class to do not print the class name in any form.

Method Detail

print

ToString.Configurator print(Object... values)

Adds the given list of values as unnamed Fields in the resulting ToString.Configuration.

Parameters:

values - values to add to the configuration.

Returns:

this ToString.Configurator.

print

ToString.Configurator print(String name,
                            Object value)

Adds the given <name,value> pair as a named Field in the resulting ToString.Configuration.

Parameters:

name - the name of the field.

value - the value of the field.

Returns:

this ToString.Configurator.

withNoClassName

ToString.Configurator withNoClassName()

Tells the ToString class to do not print the class name in any form.

Returns:

this ToString.Configurator.

withFullClassName

ToString.Configurator withFullClassName()

Tells the ToString class to print the full qualified class name.

Returns:

this ToString.Configurator.

withCustomClassName

ToString.Configurator withCustomClassName(String value)

Tells the ToString class to print the given text instead of the class name.

If you invoke this method with null than "null" will be printed instead of the class name.

Parameters:

value - value of the custom text to set.

Returns:

this ToString.Configurator.

like

String like(ToString.Printer printer)

Creates the ToString.Configuration and invokes the provided ToString.Printer in order to build the requested String representation.

This method provides the widest range of customizations. You can implement is own favorite style to display objects.

Parameters:

printer - the printer to invoke.

Returns:

the requested String representation.

likeEclipse

String likeEclipse()

Creates an output of the method Object.toString() like the one generated by the Eclipse IDE.

Returns:

an output like the one generated by the Eclipse IDE.

likeIntellij

String likeIntellij()

Creates an output of the method Object.toString() like the one generated by the IntelliJ IDE.

Returns:

an output like the one generated by the IntelliJ IDE.

likeFunction

String likeFunction()

Creates an output of the method Object.toString() in the form of a function, where the function name is the target class name and the given fields are listed as the function arguments.

This method is intended to be used to implement the Object.toString() method of functional classes.

For example if you are developing a class to apply some operations dynamically, you may want the Object.toString() of your class to be something like: Apply(MyOperation) or Apply(op:MyOperation)

Returns:

an output similar to a function.

likeTuple

String likeTuple()

Creates an output of the method Object.toString() in the form of a tuple, optionally preceded by the class name.

This method is intended to be used to implement the Object.toString() method of classes that represents relations or ordered collections of objects.

For example if you develop a class that represents a pair of objects, you may want the Object.toString() of you class to be something like: <key,value>.

Returns:

an output similar to a tuple.

using

String using(String prefix,
             String nameValueSeparator,
             String fieldSeparator,
             String suffix)

Creates an output of the method Object.toString() using the given prefix and suffix and using the given separators.

The resulting string will have the following components:

1. Optionally: the name of the class or a custom text.
2. The given prefix.
3. A list of fields separated by the given field separators where each field can be:
   • a value or
   • a name-value pair separated by the given name-value separator
4. The given suffix.

All parameters are optional and can be null or empty.

This method provides a quite wide range of customizations. If you need to customize your Object.toString() output even more you can use the method like(ToString.Printer).

Parameters:

prefix - the prefix to use before printing values.

nameValueSeparator - the text to use to separate name and value of a field.

fieldSeparator - the text to use to separate fields.

suffix - the suffix to use after printing values.

Returns:

an output similar to a tuple.

using

String using(String prefix,
             String fieldSeparator,
             String suffix)

This is a convenience method. Invokng this method is the same as invoking using(String, String, String, String) with an empty or null name-value separator.

Parameters:

prefix - the prefix to use before printing values.

fieldSeparator - the text to use to separate fields.

suffix - the suffix to use after printing values.

Returns:

an output similar to a tuple.