Package org.apache.wicket.util.string

Class AbstractStringList

  • All Implemented Interfaces:
    java.io.Serializable, IStringSequence
    Direct Known Subclasses:
    StringList
    public abstract class AbstractStringList
extends java.lang.Object
implements IStringSequence, java.io.Serializable
    An abstract base class for string list implementations. Besides having an implementation for IStringSequence (iterator(), get(int index) and size()), an AbstractStringList can be converted to a String array or a List of Strings.

    The total length of all Strings in the list can be determined by calling totalLength().

    Strings or a subset of Strings in the list can be formatted using three join() methods:

    • join(String) Joins strings together using a given separator
    • join() Joins Strings using comma as a separator
    • join(int first, int last, String) Joins a sublist of strings using a given separator
    Author:
    Jonathan Locke
    See Also:
    Serialized Form

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      abstract java.lang.String get​(int index)
      Gets a string at a given index in the sequence
      abstract IStringIterator iterator()  
      java.lang.String join()
      Joins this sequence of strings using a comma separator.
      java.lang.String join​(int first, int last, java.lang.String separator)
      Joins this sequence of strings from first index to last using a separator
      java.lang.String join​(java.lang.String separator)
      Joins this sequence of strings using a separator
      abstract int size()  
      java.lang.String[] toArray()
      Returns this String sequence as an array of Strings.
      java.util.List<java.lang.String> toList()
      Returns this String sequence as an array of Strings.
      java.lang.String toString()
      Converts this object to a string representation
      int totalLength()  

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AbstractStringList

        public AbstractStringList()

    • Method Detail

      • get

        public abstract java.lang.String get​(int index)
        Description copied from interface: IStringSequence
        Gets a string at a given index in the sequence
        Specified by:
        get in interface IStringSequence
        Parameters:
        index - The index into this string list
        Returns:
        The string at the given index
        See Also:
        IStringSequence.get(int)

      • toArray

        public java.lang.String[] toArray()
        Returns this String sequence as an array of Strings. Subclasses may provide a more efficient implementation than the one provided here.
        Returns:
        An array containing exactly this sequence of Strings

      • toList

        public final java.util.List<java.lang.String> toList()
        Returns this String sequence as an array of Strings. Subclasses may provide a more efficient implementation than the one provided here.
        Returns:
        An array containing exactly this sequence of Strings

      • totalLength

        public int totalLength()
        Returns:
        The total length of all Strings in this sequence.

      • join

        public final java.lang.String join()
        Joins this sequence of strings using a comma separator. For example, if this sequence contains [1 2 3], the result of calling this method will be "1, 2, 3".
        Returns:
        The joined String

      • join

        public final java.lang.String join​(java.lang.String separator)
        Joins this sequence of strings using a separator
        Parameters:
        separator - The separator to use
        Returns:
        The joined String

      • join

        public final java.lang.String join​(int first,
                                   int last,
                                   java.lang.String separator)
        Joins this sequence of strings from first index to last using a separator
        Parameters:
        first - The first index to use, inclusive
        last - The last index to use, exclusive
        separator - The separator to use
        Returns:
        The joined String

      • toString

        public java.lang.String toString()
        Converts this object to a string representation
        Overrides:
        toString in class java.lang.Object
        Returns:
        String version of this object