Package com.luciad.util.collections

Interface ILcdCharList

All Superinterfaces:
Cloneable, Collection<Character>, ILcdCloneable, Iterable<Character>, List<Character>, SequencedCollection<Character>
All Known Implementing Classes:
TLcdCharArrayList
public interface ILcdCharList extends List<Character>, ILcdCloneable
A List interface that is optimized for chars. It provides extra methods using char primitives, instead of Character objects.
Since:
9.0

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    addAll(char[] aValues)
    Equivalent to addAll(size(), aValues, 0, aValues.length.
    default boolean
    addAll(char[] aValues, int aOffset, int aLength)
    Equivalent to addAll(size(), aValues, aOffset, aLength.
    default boolean
    addAll(int aStartIndex, char[] aValues)
    Equivalent to addAll(aStartIndex, aValues, 0, aValues.length.
    default boolean
    addAll(int aStartIndex, char[] aValues, int aOffset, int aLength)
    Adds aLength integer values from the given array to this list, starting from the given aOffset
    boolean
    addChar(char aValue)
    Appends the specified value to the end of this list (optional operation).
    void
    addChar(int aIndex, char aValue)
    Inserts the specified value at the specified position in this list (optional operation).
    ILcdCharList
    clone()
    Creates and returns a copy of this object.
    boolean
    containsChar(char aValue)
    Returns true if this list contains the specified value.
    char
    getChar(int aIndex)
    Returns the value at the specified position in this list.
    int
    indexOfChar(char aValue)
    Returns the index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value.
    int
    lastIndexOfChar(char aValue)
    Returns the index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value.
    boolean
    removeChar(char aValue)
    Removes the first occurrence of the specified value from this list, if it is present (optional operation).
    char
    removeChar(int aIndex)
    Removes the value at the specified position in this list (optional operation).
    char
    setChar(int aIndex, char aValue)
    Replaces the value at the specified position in this list with the specified value (optional operation).
    char[]
    toCharArray()
    Returns an array containing all of the values in this list in proper sequence (from first to last value).
    char[]
    toCharArray(char[] anArray)
    Returns an array containing all of the values in this list in proper sequence (from first to last value); If the list fits in the specified array, t is returned therein.

    Methods inherited from interface java.util.Collection

    parallelStream, removeIf, stream, toArray

    Methods inherited from interface java.lang.Iterable

    forEach

    Methods inherited from interface java.util.List

    add, add, addAll, addAll, addFirst, addLast, clear, contains, containsAll, equals, get, getFirst, getLast, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeFirst, removeLast, replaceAll, retainAll, reversed, set, size, sort, spliterator, subList, toArray, toArray

  • Method Details

    • getChar

      char getChar(int aIndex)
      Returns the value at the specified position in this list.
      Parameters:
      aIndex - index of the value to return
      Returns:
      the value at the specified position in this list
      Throws:
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size()).

    • setChar

      char setChar(int aIndex, char aValue)
      Replaces the value at the specified position in this list with the specified value (optional operation).
      Parameters:
      aIndex - index of the value to replace
      aValue - value to be stored at the specified position
      Returns:
      the value previously at the specified position
      Throws:
      UnsupportedOperationException - if the set operation is not supported by this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • addChar

      boolean addChar(char aValue)
      Appends the specified value to the end of this list (optional operation).
      Parameters:
      aValue - value to be appended to this list
      Returns:
      true
      Throws:
      UnsupportedOperationException - if the add operation is not supported by this list

    • addChar

      void addChar(int aIndex, char aValue)
      Inserts the specified value at the specified position in this list (optional operation). Shifts the value currently at that position (if any) and any subsequent values to the right (adds one to their indices).
      Parameters:
      aIndex - index at which the specified value is to be inserted
      aValue - value to be inserted
      Throws:
      UnsupportedOperationException - if the add operation is not supported by this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index > size())

    • addAll

      default boolean addAll(char[] aValues)
      Equivalent to addAll(size(), aValues, 0, aValues.length.
      Since:
      2018.0
      See Also:

    • addAll

      default boolean addAll(char[] aValues, int aOffset, int aLength)
      Equivalent to addAll(size(), aValues, aOffset, aLength.
      Since:
      2018.0
      See Also:

    • addAll

      default boolean addAll(int aStartIndex, char[] aValues)
      Equivalent to addAll(aStartIndex, aValues, 0, aValues.length.
      Since:
      2018.0
      See Also:

    • addAll

      default boolean addAll(int aStartIndex, char[] aValues, int aOffset, int aLength)
      Adds aLength integer values from the given array to this list, starting from the given aOffset
      Parameters:
      aStartIndex - The position in this list where to start inserting the given integer values.
      aValues - The array containing the integer values to add to this list
      aOffset - The offset in aValues from where to start copying the integer values
      aLength - The number of integer values to copy from aValues to this list.
      Returns:
      Whether this list was modified as a result of this call.
      Throws:
      IndexOutOfBoundsException - if aStartIndex is less than zero or larger than the current size of this list.
      IndexOutOfBoundsException - if aOffset + aLength exceeds the length of aValues
      IndexOutOfBoundsException - if aOffset is negative
      IndexOutOfBoundsException - if aLength is negative
      Since:
      2018.0

    • removeChar

      boolean removeChar(char aValue)
      Removes the first occurrence of the specified value from this list, if it is present (optional operation). If this list does not contain the value, it is unchanged. Returns true if this list contained the specified value (or equivalently, if this list changed as a result of the call).
      Parameters:
      aValue - value to be removed from this list, if present
      Returns:
      true if this list contained the specified value
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this list

    • removeChar

      char removeChar(int aIndex)
      Removes the value at the specified position in this list (optional operation). Shifts any subsequent values to the left (subtracts one from their indices). Returns the value that was removed from the list.
      Parameters:
      aIndex - the index of the value to be removed
      Returns:
      the value previously at the specified position
      Throws:
      UnsupportedOperationException - if the remove operation is not supported by this list
      IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

    • toCharArray

      char[] toCharArray()
      Returns an array containing all of the values in this list in proper sequence (from first to last value). The returned array will be "safe" in that no references to it are maintained by this list. (In other words, this method must allocate a new array even if this list is backed by an array). The caller is thus free to modify the returned array.
      Returns:
      an array containing all of the values in this list in proper sequence

    • toCharArray

      char[] toCharArray(char[] anArray)
      Returns an array containing all of the values in this list in proper sequence (from first to last value); If the list fits in the specified array, t is returned therein. Otherwise, a new array is allocated with the size of this list. If the list fits in the specified array with room to spare (i.e., the array has more values than the list), the value in the array immediately following the end of the list is set to 0. (This is useful in determining the length of the list only if the caller knows that the list does not contain any 0 values.)
      Parameters:
      anArray - the array into which the values of this list are to be stored, if it is big enough; otherwise, a new array is allocated for this purpose.
      Returns:
      an array containing the values of this list
      Throws:
      NullPointerException - if the specified array is null

    • containsChar

      boolean containsChar(char aValue)
      Returns true if this list contains the specified value.
      Parameters:
      aValue - value whose presence in this list is to be tested
      Returns:
      true if this list contains the specified value

    • indexOfChar

      int indexOfChar(char aValue)
      Returns the index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value.
      Parameters:
      aValue - value to search for
      Returns:
      the index of the first occurrence of the specified value in this list, or -1 if this list does not contain the value

    • lastIndexOfChar

      int lastIndexOfChar(char aValue)
      Returns the index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value.
      Parameters:
      aValue - value to search for
      Returns:
      the index of the last occurrence of the specified value in this list, or -1 if this list does not contain the value

    • clone

      ILcdCharList clone()
      Creates and returns a copy of this object.
      Specified by:
      clone in interface ILcdCloneable
      Returns:
      a copy of this object.
      See Also: