Package org.refcodes.textual

Class VerboseTextBuilderImpl

  • All Implemented Interfaces:
    VerboseTextBuilder

    public class VerboseTextBuilderImpl
extends java.lang.Object
implements VerboseTextBuilder
    The Class VerboseTextBuilderImpl.
    Author:
    steiner

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Character getCollectionHead​()
      gets the String to be used for the begin of a collection.
      java.lang.Character getCollectionTail​()
      gets the String to be used for the begin of a collection.
      java.lang.Object[] getElements​()
      Gets the elements for the elements property.
      void setCollectionHead​(java.lang.Character aHead)
      Sets the String to be used for the begin of a collection.
      void setCollectionTail​(java.lang.Character aTail)
      Sets the String to be used for the begin of a collection.
      void setElements​(java.lang.Object[] aElements)
      Sets the elements for the elements property.
      void setElements​(java.util.Collection<?> aElements)
      Sets the elements.
      void setElements​(java.util.Map<?,?> aElements)
      Sets the elements.
      java.lang.String toString​()
      The String being build by the builder upon the settings of the attributes.
      java.lang.String toString​(java.lang.Boolean[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Byte[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Character[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Double[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Float[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Integer[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Long[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Object aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Object[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.Short[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.lang.String[] aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.util.Collection<?> aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      java.lang.String toString​(java.util.Map<?,?> aElements)
      The String being build by the builder upon the settings of the attributes and the provided argument.
      protected static java.lang.String toVerboseString​(java.lang.Character aCollectionHead, java.util.Collection<?> aCollection, java.lang.Character aCollectionTail)
      To verbose string.
      protected static java.lang.String toVerboseString​(java.lang.Character aCollectionHead, java.util.Map<?,?> aMap, java.lang.Character aCollectionTail)
      To verbose string.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • VerboseTextBuilderImpl

        public VerboseTextBuilderImpl​()

    • Method Detail

      • setCollectionHead

        public void setCollectionHead​(java.lang.Character aHead)
        Sets the String to be used for the begin of a collection.
        Specified by:
        setCollectionHead in interface VerboseTextBuilder
        Parameters:
        aHead - The begin of a collection.

      • getCollectionHead

        public java.lang.Character getCollectionHead​()
        gets the String to be used for the begin of a collection.
        Specified by:
        getCollectionHead in interface VerboseTextBuilder
        Returns:
        The begin of a collection.

      • setCollectionTail

        public void setCollectionTail​(java.lang.Character aTail)
        Sets the String to be used for the begin of a collection.
        Specified by:
        setCollectionTail in interface VerboseTextBuilder
        Parameters:
        aTail - The begin of a collection.

      • getCollectionTail

        public java.lang.Character getCollectionTail​()
        gets the String to be used for the begin of a collection.
        Specified by:
        getCollectionTail in interface VerboseTextBuilder
        Returns:
        The begin of a collection.

      • getElements

        public java.lang.Object[] getElements​()
        Gets the elements for the elements property.
        Specified by:
        getElements in interface VerboseTextBuilder
        Returns:
        The elements being stored by the elements property.

      • setElements

        public void setElements​(java.lang.Object[] aElements)
        Sets the elements for the elements property.
        Specified by:
        setElements in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.

      • setElements

        public void setElements​(java.util.Collection<?> aElements)
        Sets the elements.
        Specified by:
        setElements in interface VerboseTextBuilder
        Parameters:
        aElements - the new elements

      • setElements

        public void setElements​(java.util.Map<?,?> aElements)
        Sets the elements.
        Specified by:
        setElements in interface VerboseTextBuilder
        Parameters:
        aElements - the elements

      • toString

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

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.util.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.util.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toString

        public java.lang.String toString​(java.lang.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 VerboseTextBuilder.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 VerboseTextBuilder.withElements(Collection) with VerboseTextBuilder.toString().
        Specified by:
        toString in interface VerboseTextBuilder
        Parameters:
        aElements - The elements to be stored by the elements property.
        Returns:
        The according resulting String

      • toVerboseString

        protected static java.lang.String toVerboseString​(java.lang.Character aCollectionHead,
                                                  java.util.Collection<?> aCollection,
                                                  java.lang.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

      • toVerboseString

        protected static java.lang.String toVerboseString​(java.lang.Character aCollectionHead,
                                                  java.util.Map<?,?> aMap,
                                                  java.lang.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