Interface TokenStream.CharacterStream

All Known Implementing Classes:
TokenStream.CharacterArrayStream
Enclosing class:
TokenStream

public static interface TokenStream.CharacterStream
Interface used by a TokenStream.Tokenizer to iterate through the characters in the content input to the TokenStream.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Determine if there is another character available in this stream.
    int
    Get the index for the last character returned from next().
    boolean
    isNext(char c)
    Determine if the next character on the sream is the supplied value.
    boolean
    isNext(char nextChar, char followingChar)
    Determine if the next two characters on the stream match the supplied values.
    boolean
    isNext(char nextChar, char nextChar2, char nextChar3)
    Determine if the next three characters on the sream match the supplied values.
    boolean
    isNextAnyOf(char[] characters)
    Determine if the next character on the stream matches one of the supplied characters.
    boolean
    isNextAnyOf(String characters)
    Determine if the next character on the stream matches one of the supplied characters.
    boolean
    Determine if the next character on the stream is a letter or digit.
    boolean
    Determine if the next character on the stream is a valid XML character.
    boolean
    Determine if the next character on the sream is a valid XML NCName character.
    boolean
    Determine if the next character on the sream is a valid XML NCName character.
    boolean
    Determine if the next character on the stream is a whitespace character.
    char
    Obtain the next character value, and advance the stream.
    position(int startIndex)
    Get the position for the last character returned from next().
    substring(int startIndex, int endIndex)
    Get the content from the start position to the end position.
  • Method Details

    • hasNext

      boolean hasNext()
      Determine if there is another character available in this stream.
      Returns:
      true if there is another character (and next() can be called), or false otherwise
    • next

      char next()
      Obtain the next character value, and advance the stream.
      Returns:
      the next character
      Throws:
      NoSuchElementException - if there is no next character
    • index

      int index()
      Get the index for the last character returned from next().
      Returns:
      the index of the last character returned
    • position

      Position position(int startIndex)
      Get the position for the last character returned from next().
      Parameters:
      startIndex - the starting index
      Returns:
      the position of the last character returned; never null
    • substring

      String substring(int startIndex, int endIndex)
      Get the content from the start position to the end position.
      Parameters:
      startIndex - the starting index
      endIndex - the index after the last character to include
      Returns:
      the content
    • isNextWhitespace

      boolean isNextWhitespace()
      Determine if the next character on the stream is a whitespace character. This method does not advance the stream.
      Returns:
      true if there is a next character and it is a whitespace character, or false otherwise
    • isNextLetterOrDigit

      boolean isNextLetterOrDigit()
      Determine if the next character on the stream is a letter or digit. This method does not advance the stream.
      Returns:
      true if there is a next character and it is a letter or digit, or false otherwise
    • isNextValidXmlCharacter

      boolean isNextValidXmlCharacter()
      Determine if the next character on the stream is a valid XML character. This method does not advance the stream.
      Returns:
      true if there is a next character and it is a valid XML character, or false otherwise
    • isNextValidXmlNameCharacter

      boolean isNextValidXmlNameCharacter()
      Determine if the next character on the sream is a valid XML NCName character. This method does not advance the stream.
      Returns:
      true if there is a next character and it is a valid XML Name character, or false otherwise
    • isNextValidXmlNcNameCharacter

      boolean isNextValidXmlNcNameCharacter()
      Determine if the next character on the sream is a valid XML NCName character. This method does not advance the stream.
      Returns:
      true if there is a next character and it is a valid XML NCName character, or false otherwise
    • isNext

      boolean isNext(char c)
      Determine if the next character on the sream is the supplied value. This method does not advance the stream.
      Parameters:
      c - the character value to compare to the next character on the stream
      Returns:
      true if there is a next character and it is the supplied character, or false otherwise
    • isNext

      boolean isNext(char nextChar, char followingChar)
      Determine if the next two characters on the stream match the supplied values. This method does not advance the stream.
      Parameters:
      nextChar - the character value to compare to the next character on the stream
      followingChar - the character value to compare to the character immediately after the next character on the stream
      Returns:
      true if there are at least two characters left on the stream and the first matches nextChar and the second matches followingChar
    • isNext

      boolean isNext(char nextChar, char nextChar2, char nextChar3)
      Determine if the next three characters on the sream match the supplied values. This method does not advance the stream.
      Parameters:
      nextChar - the character value to compare to the next character on the stream
      nextChar2 - the character value to compare to the second character on the stream
      nextChar3 - the character value to compare to the second character on the stream
      Returns:
      true if there are at least two characters left on the stream and the first matches nextChar and the second matches followingChar
    • isNextAnyOf

      boolean isNextAnyOf(char[] characters)
      Determine if the next character on the stream matches one of the supplied characters. This method does not advance the stream.
      Parameters:
      characters - the characters to match
      Returns:
      true if there is a next character and it does match one of the supplied characters, or false otherwise
    • isNextAnyOf

      boolean isNextAnyOf(String characters)
      Determine if the next character on the stream matches one of the supplied characters. This method does not advance the stream.
      Parameters:
      characters - the characters to match
      Returns:
      true if there is a next character and it does match one of the supplied characters, or false otherwise