Module org.refcodes.textual
Package org.refcodes.textual

Class VerboseTextBuilder

java.lang.Object
org.refcodes.textual.VerboseTextBuilder
public class VerboseTextBuilder extends Object
The VerboseTextBuilder us a utility-builder for creating human readable String 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 whose Object.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".

  • Field Details

    • DEFAULT_COLLECTION_HEAD

      public static final char DEFAULT_COLLECTION_HEAD
      See Also:

    • DEFAULT_COLLECTION_TAIL

      public static final char DEFAULT_COLLECTION_TAIL
      See Also:

  • Constructor Details

    • VerboseTextBuilder

      public VerboseTextBuilder()

  • Method Details

    • setCollectionHead

      public void setCollectionHead(Character aHead)
      Sets the String to be used for the begin of a collection.
      Parameters:
      aHead - The begin of a collection.

    • getCollectionHead

      public Character getCollectionHead()
      Gets the String to be used for the begin of a collection.
      Returns:
      The begin of a collection.

    • setCollectionTail

      public void setCollectionTail(Character aTail)
      Sets the String to be used for the begin of a collection.
      Parameters:
      aTail - The begin of a collection.

    • getCollectionTail

      public Character getCollectionTail()
      gets the String to be used for the begin of a collection.
      Returns:
      The begin of a collection.

    • getElements

      public Object[] getElements()
      Gets the elements for the elements property.
      Returns:
      The elements being stored by the elements property.

    • setElements

      public void setElements(Object[] aElements)
      Sets the elements for the elements property.
      Parameters:
      aElements - The elements to be stored by the elements property.

    • setElements

      public void setElements(Collection<?> aElements)
      Sets the elements.
      Parameters:
      aElements - the new elements

    • setElements

      public void setElements(Map<?,?> aElements)
      Sets the elements for the elements property.
      Parameters:
      aElements - The elements to be stored by the elements property.

    • setElements

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public 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

      public void setElements(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

      public 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

      public 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

      public 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

      public void setElements(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

      public void setElements(String[] aElements)
      Sets the CSV elements for the CSV elements property.
      Parameters:
      aElements - The CSV elements to be stored by the CSV elements property.

    • withElements

      public VerboseTextBuilder withElements(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.

    • withElements

      public VerboseTextBuilder withElements(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

      public void setElements(Object aElements)
      Sets the elements for the elements property.
      Parameters:
      aElements - The elements to be stored by the elements property.

    • withElements

      public VerboseTextBuilder withElements(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.

    • withElements

      public VerboseTextBuilder withElements(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

      public String toString()
      The String being build by the builder upon the settings of the attributes.
      Overrides:
      toString in class Object
      Returns:
      The according resulting String

    • toString

      public String toString(boolean[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(byte[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(short[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(int[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(long[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(float[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(double[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(char[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Boolean[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Byte[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Short[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Integer[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Long[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Float[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Double[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Character[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(String[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Object[] aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Collection<?> aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • toString

      public String toString(Map<?,?> aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • withCollectionHead

      public VerboseTextBuilder withCollectionHead(Character aHead)
      Sets the String to be used for the begin of a collection.
      Parameters:
      aHead - The begin of a collection.
      Returns:
      This instance as of the builder pattern.

    • toString

      public String toString(Object aElements)
      The String 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 via withElements(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 of withElements(Collection) with toString().
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(boolean[] aElements)
      This method represents a shortcut for the instance method toString(boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(byte[] aElements)
      This method represents a shortcut for the instance method toString(byte[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(short[] aElements)
      This method represents a shortcut for the instance method toString(short[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(int[] aElements)
      This method represents a shortcut for the instance method toString(int[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(long[] aElements)
      This method represents a shortcut for the instance method toString(long[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(float[] aElements)
      This method represents a shortcut for the instance method toString(float[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(double[] aElements)
      This method represents a shortcut for the instance method toString(double[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(char[] aElements)
      This method represents a shortcut for the instance method toString(char[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Boolean[] aElements)
      This method represents a shortcut for the instance method toString(Boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Byte[] aElements)
      This method represents a shortcut for the instance method toString(Byte[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Short[] aElements)
      This method represents a shortcut for the instance method toString(Short[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Integer[] aElements)
      This method represents a shortcut for the instance method toString(Integer[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Long[] aElements)
      This method represents a shortcut for the instance method toString(Long[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Float[] aElements)
      This method represents a shortcut for the instance method toString(Float[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Double[] aElements)
      This method represents a shortcut for the instance method toString(Double[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Character[] aElements)
      This method represents a shortcut for the instance method toString(Character[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(String[] aElements)
      This method represents a shortcut for the instance method toString(String[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Object[] aElements)
      This method represents a shortcut for the instance method toString(Boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Collection<?> aElements)
      This method represents a shortcut for the instance method toString(Boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Map<?,?> aElements)
      This method represents a shortcut for the instance method toString(Boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asString

      public static String asString(Object aElements)
      This method represents a shortcut for the instance method toString(Boolean[]) though with public settings.
      Parameters:
      aElements - The elements to be transformed to a human readable String,
      Returns:
      The according resulting String

    • asVerboseString

      protected static String asVerboseString(Character aCollectionHead, Collection<?> aCollection, Character aCollectionTail)
      To verbose string.
      Parameters:
      aCollectionHead - The head sequence for the collection.
      aCollection - the collection
      aCollectionTail - The tail sequence for the collection.
      Returns:
      the string

    • asVerboseString

      protected static String asVerboseString(Character aCollectionHead, Map<?,?> aMap, Character aCollectionTail)
      To verbose string.
      Parameters:
      aCollectionHead - The head sequence for the collection.
      aMap - the map
      aCollectionTail - The tail sequence for the collection.
      Returns:
      the string