Package org.refcodes.textual

Interface VerboseTextBuilder

  • All Known Implementing Classes:
    VerboseTextBuilderImpl

    public interface VerboseTextBuilder
    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".

    • Method Detail

      • setCollectionHead

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

      • withCollectionHead

        default 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.

      • getCollectionHead

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

      • setCollectionTail

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

      • withCollectionTail

        default VerboseTextBuilder withCollectionTail​(Character aTail)
        Sets the String to be used for the begin of a collection.
        Parameters:
        aTail - The begin of a collection.
        Returns:
        This instance as of the builder pattern.

      • getCollectionTail

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

      • getElements

        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​(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​(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​(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​(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​(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​(Object[] aElements)
        Sets the elements for the elements property.
        Parameters:
        aElements - The elements to be stored by the elements property.

      • withElements

        default 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.

      • setElements

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

      • withElements

        default 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

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

      • withElements

        default 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.

      • setElements

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

      • withElements

        default 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

        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

        default 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

        default 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

        default 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

        default 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

        default 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

        default 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

        default 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

        default 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

        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

        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

        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

        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

        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

        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

        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

        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

        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

        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

        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

        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

        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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • asString

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

      • build

        static VerboseTextBuilder build​()
        This is a convenience method for easily instantiating the according builder.
        Returns:
        an instance (using a default implementation) of this builder