Package org.refcodes.textual
Interface VerboseTextBuilder
-
- All Known Implementing Classes:
VerboseTextBuilderImpl
public interface VerboseTextBuilder
TheVerboseTextBuilder
us a utility-builder for creating human readableString
objects from arrays, collections or maps (instead of solely printing out the object references of those collections). The arrays, collections or maps may be nested in any way still producing accordingly indented and parenthesized text down to the single elements in those collections whoseObject.toString()
method is invoked . This utility-builder is very useful when printing debug or error logs or inspecting such the like data structures "on the fly".
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description java.lang.Object[]
getElements()
Gets the elements for the elements property.default void
setElements(boolean[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(byte[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(char[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(double[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(float[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(int[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(long[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(short[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Boolean[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Byte[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Character[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Double[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Float[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Integer[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Long[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.Object aElements)
Sets the elements for the elements property.void
setElements(java.lang.Object[] aElements)
Sets the elements for the elements property.default void
setElements(java.lang.Short[] aElements)
Sets the CSV elements for the CSV elements property.default void
setElements(java.lang.String[] aElements)
Sets the CSV elements for the CSV elements property.void
setElements(java.util.Collection<?> aElements)
Sets the elements for the elements property.void
setElements(java.util.Map<?,?> aElements)
Sets the elements for the elements property.java.lang.String
toString()
TheString
being build by the builder upon the settings of the attributes.default java.lang.String
toString(boolean[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(byte[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(char[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(double[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(float[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(int[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(long[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default java.lang.String
toString(short[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Boolean[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Byte[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Character[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Double[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Float[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Integer[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Long[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Object aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Object[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.Short[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.lang.String[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.util.Collection<?> aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.java.lang.String
toString(java.util.Map<?,?> aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument.default VerboseTextBuilder
withElements(boolean[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(byte[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(char[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(double[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(float[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(int[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(long[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(short[] aElements)
Sets the CSV elements for the CSV elements property.default VerboseTextBuilder
withElements(java.lang.Object aElements)
Sets the elements for the elements property.default VerboseTextBuilder
withElements(java.lang.Object[] aElements)
Sets the elements for the elements property.default VerboseTextBuilder
withElements(java.util.Collection<?> aElements)
Sets the elements for the elements property.default VerboseTextBuilder
withElements(java.util.Map<?,?> aElements)
Sets the elements for the elements property.
-
-
-
Method Detail
-
getElements
java.lang.Object[] getElements()
Gets the elements for the elements property.- Returns:
- The elements being stored by the elements property.
-
setElements
default void setElements(boolean[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(byte[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(short[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(int[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(long[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(float[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(double[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(char[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
withElements
default VerboseTextBuilder withElements(boolean[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(byte[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(short[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(int[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(long[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(float[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(double[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
withElements
default VerboseTextBuilder withElements(char[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.- Returns:
- The builder for applying multiple build operations.
-
setElements
default void setElements(java.lang.Boolean[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Byte[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Short[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Integer[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Long[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Float[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Double[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.Character[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
default void setElements(java.lang.String[] aElements)
Sets the CSV elements for the CSV elements property.- Parameters:
aElements
- The CSV elements to be stored by the CSV elements property.
-
setElements
void setElements(java.lang.Object[] aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.
-
withElements
default VerboseTextBuilder withElements(java.lang.Object[] aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The builder for applying multiple build operations.
-
setElements
void setElements(java.util.Collection<?> aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.
-
withElements
default VerboseTextBuilder withElements(java.util.Collection<?> aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The builder for applying multiple build operations.
-
setElements
default void setElements(java.lang.Object aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.
-
withElements
default VerboseTextBuilder withElements(java.lang.Object aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The builder for applying multiple build operations.
-
setElements
void setElements(java.util.Map<?,?> aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.
-
withElements
default VerboseTextBuilder withElements(java.util.Map<?,?> aElements)
Sets the elements for the elements property.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The builder for applying multiple build operations.
-
toString
java.lang.String toString()
TheString
being build by the builder upon the settings of the attributes.- Overrides:
toString
in classjava.lang.Object
- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(boolean[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(byte[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(short[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(int[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(long[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(float[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(double[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
default java.lang.String toString(char[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Boolean[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Byte[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Short[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Integer[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Long[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Float[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Double[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Character[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.String[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Object[] aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.util.Collection<?> aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.lang.Object aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
toString
java.lang.String toString(java.util.Map<?,?> aElements)
TheString
being build by the builder upon the settings of the attributes and the provided argument. This method is to be side effect free in terms of the elements (and the verbose result) are not part of the state for this instance (from the point of view of this method). Still changing for example the elements viawithElements(Collection)
can cause side effects! For avoiding thread race conditions / side effects regarding the elements text (and the verbose result), use this method instead of the combination ofwithElements(Collection)
withtoString()
.- Parameters:
aElements
- The elements to be stored by the elements property.- Returns:
- The according resulting
String
-
-