Interface CharTokenSequence

All Superinterfaces:
CharSequence, ScalarTokenSequence, ScalarTyped, TokenSequence, TokenTyped
All Known Subinterfaces:
MutableCharTokenSequence
All Known Implementing Classes:
CharTokenList, SparseCharTokenList

public interface CharTokenSequence extends ScalarTokenSequence, CharSequence
A TokenSequence containing character valued data.
See Also:
  • TokenTypeConstant#CHAR
  • Method Details

    • getToken

      CharValued getToken(int index)
      Description copied from interface: TokenSequence
      Gets the value at the specified position.
      Specified by:
      getToken in interface ScalarTokenSequence
      Specified by:
      getToken in interface TokenSequence
      Parameters:
      index - the index of the token
      Returns:
      the value
    • getChar

      char getChar(int index)
      Gets the value of the specified token as a char.
      Parameters:
      index - the position of the token in the sequence
      Returns:
      the value of the token. If the token is null valued, Character.MAX_VALUE is returned.
    • getValues

      void getValues(int start, char[] values, boolean[] nulls, int offset, int length)
      Gets the values and null indicators for a range of tokens.
      Parameters:
      start - the starting index of the range
      values - an array into which to place element values
      nulls - an array into which to place null indicator values
      offset - the starting offset into the target arrays. That is, elements[offset] and nulls[offset] will get the value and null indicator respectively of the token at position start, and so on.
      length - number of tokens to get
    • getString

      String getString(int start, int length)
      Gets a subsequence of tokens as a string. An null values in the subsequence are represented as Character.MAX_VALUE.
      Parameters:
      start - the index of the first token in the subsequence
      length - the length of the subsequence
      Returns:
      a string containing the values of the selected tokens.
    • newValueIterator

      CharValuedIterator newValueIterator()
      Description copied from interface: TokenSequence
      Creates an iterator over the non-null values of this sequence. The iterator will automatically be reset as modifications are made to the sequence.
      Specified by:
      newValueIterator in interface ScalarTokenSequence
      Specified by:
      newValueIterator in interface TokenSequence
      Returns:
      an newly-created iterator over the non-null values of this sequence.