Interface ParseText

All Superinterfaces:
CharSequence
public interface ParseText extends CharSequence
Represents the text from the source document that is to be parsed.

This interface is normally only of interest to users who wish to create custom tag types.

The parse text is defined as the entire text of the source document in lower case, with all ignored segments replaced by space characters.

The text is stored in lower case to make case insensitive parsing as efficient as possible.

This interface provides many methods which are also provided by the java.lang.String class, but adds an extra parameter called breakAtIndex to the various indexOf methods. This parameter allows a search on only a specified segment of the text, which is not possible using the normal String class.

ParseText instances are obtained using the Source.getParseText() method.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NO_BREAK
    A value to use as the breakAtIndex argument in certain methods to indicate that the search should continue to the start or end of the parse text.

  • Method Summary

    Modifier and Type
    Method
    Description
    char
    charAt(int index)
    Returns the character at the specified index.
    boolean
    containsAt(String str, int pos)
    Indicates whether this parse text contains the specified string at the specified position.
    int
    indexOf(char searchChar, int fromIndex)
    Returns the index within this parse text of the first occurrence of the specified character, starting the search at the position specified by fromIndex.
    int
    indexOf(char searchChar, int fromIndex, int breakAtIndex)
    Returns the index within this parse text of the first occurrence of the specified character, starting the search at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.
    int
    indexOf(String searchString, int fromIndex)
    Returns the index within this parse text of the first occurrence of the specified string, starting the search at the position specified by fromIndex.
    int
    indexOf(String searchString, int fromIndex, int breakAtIndex)
    Returns the index within this parse text of the first occurrence of the specified string, starting the search at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.
    int
    lastIndexOf(char searchChar, int fromIndex)
    Returns the index within this parse text of the last occurrence of the specified character, searching backwards starting at the position specified by fromIndex.
    int
    lastIndexOf(char searchChar, int fromIndex, int breakAtIndex)
    Returns the index within this parse text of the last occurrence of the specified character, searching backwards starting at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.
    int
    lastIndexOf(String searchString, int fromIndex)
    Returns the index within this parse text of the last occurrence of the specified string, searching backwards starting at the position specified by fromIndex.
    int
    lastIndexOf(String searchString, int fromIndex, int breakAtIndex)
    Returns the index within this parse text of the last occurrence of the specified string, searching backwards starting at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.
    int
    length()
    Returns the length of the parse text.
    CharSequence
    subSequence(int begin, int end)
    Returns a new character sequence that is a subsequence of this sequence.
    String
    toString()
    Returns the content of the parse text as a String.

    Methods inherited from interface CharSequence

    chars, codePoints, getChars, isEmpty

  • Field Details

    • NO_BREAK

      static final int NO_BREAK
      A value to use as the breakAtIndex argument in certain methods to indicate that the search should continue to the start or end of the parse text.
      See Also:

  • Method Details

    • charAt

      char charAt(int index)
      Returns the character at the specified index.
      Specified by:
      charAt in interface CharSequence
      Parameters:
      index - the index of the character.
      Returns:
      the character at the specified index, which is always in lower case.

    • containsAt

      boolean containsAt(String str, int pos)
      Indicates whether this parse text contains the specified string at the specified position.

      This method is analogous to the java.lang.String.startsWith(String prefix, int toffset) method.

      Parameters:
      str - a string.
      pos - the position (index) in this parse text at which to check for the specified string.
      Returns:
      true if this parse text contains the specified string at the specified position, otherwise false.

    • indexOf

      int indexOf(char searchChar, int fromIndex)
      Returns the index within this parse text of the first occurrence of the specified character, starting the search at the position specified by fromIndex.

      If the specified character is not found then -1 is returned.

      Parameters:
      searchChar - a character.
      fromIndex - the index to start the search from.
      Returns:
      the index within this parse text of the first occurrence of the specified character within the specified range, or -1 if the character is not found.

    • indexOf

      int indexOf(char searchChar, int fromIndex, int breakAtIndex)
      Returns the index within this parse text of the first occurrence of the specified character, starting the search at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.

      The position specified by breakAtIndex is not included in the search.

      If the search is to continue to the end of the text, the value ParseText.NO_BREAK should be specified as the breakAtIndex.

      If the specified character is not found then -1 is returned.

      Parameters:
      searchChar - a character.
      fromIndex - the index to start the search from.
      breakAtIndex - the index at which to break off the search, or NO_BREAK if the search is to continue to the end of the text.
      Returns:
      the index within this parse text of the first occurrence of the specified character within the specified range, or -1 if the character is not found.

    • indexOf

      int indexOf(String searchString, int fromIndex)
      Returns the index within this parse text of the first occurrence of the specified string, starting the search at the position specified by fromIndex.

      If the specified string is not found then -1 is returned.

      Parameters:
      searchString - a string.
      fromIndex - the index to start the search from.
      Returns:
      the index within this parse text of the first occurrence of the specified string within the specified range, or -1 if the string is not found.

    • indexOf

      int indexOf(String searchString, int fromIndex, int breakAtIndex)
      Returns the index within this parse text of the first occurrence of the specified string, starting the search at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.

      The position specified by breakAtIndex is not included in the search.

      If the search is to continue to the end of the text, the value ParseText.NO_BREAK should be specified as the breakAtIndex.

      If the specified string is not found then -1 is returned.

      Parameters:
      searchString - a string.
      fromIndex - the index to start the search from.
      breakAtIndex - the index at which to break off the search, or NO_BREAK if the search is to continue to the end of the text.
      Returns:
      the index within this parse text of the first occurrence of the specified string within the specified range, or -1 if the string is not found.

    • lastIndexOf

      int lastIndexOf(char searchChar, int fromIndex)
      Returns the index within this parse text of the last occurrence of the specified character, searching backwards starting at the position specified by fromIndex.

      If the specified character is not found then -1 is returned.

      Parameters:
      searchChar - a character.
      fromIndex - the index to start the search from.
      Returns:
      the index within this parse text of the last occurrence of the specified character within the specified range, or -1 if the character is not found.

    • lastIndexOf

      int lastIndexOf(char searchChar, int fromIndex, int breakAtIndex)
      Returns the index within this parse text of the last occurrence of the specified character, searching backwards starting at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.

      The position specified by breakAtIndex is not included in the search.

      If the search is to continue to the start of the text, the value ParseText.NO_BREAK should be specified as the breakAtIndex.

      If the specified character is not found then -1 is returned.

      Parameters:
      searchChar - a character.
      fromIndex - the index to start the search from.
      breakAtIndex - the index at which to break off the search, or NO_BREAK if the search is to continue to the start of the text.
      Returns:
      the index within this parse text of the last occurrence of the specified character within the specified range, or -1 if the character is not found.

    • lastIndexOf

      int lastIndexOf(String searchString, int fromIndex)
      Returns the index within this parse text of the last occurrence of the specified string, searching backwards starting at the position specified by fromIndex.

      If the specified string is not found then -1 is returned.

      Parameters:
      searchString - a string.
      fromIndex - the index to start the search from.
      Returns:
      the index within this parse text of the last occurrence of the specified string within the specified range, or -1 if the string is not found.

    • lastIndexOf

      int lastIndexOf(String searchString, int fromIndex, int breakAtIndex)
      Returns the index within this parse text of the last occurrence of the specified string, searching backwards starting at the position specified by fromIndex, and breaking the search at the index specified by breakAtIndex.

      The position specified by breakAtIndex is not included in the search.

      If the search is to continue to the start of the text, the value ParseText.NO_BREAK should be specified as the breakAtIndex.

      If the specified string is not found then -1 is returned.

      Parameters:
      searchString - a string.
      fromIndex - the index to start the search from.
      breakAtIndex - the index at which to break off the search, or NO_BREAK if the search is to continue to the start of the text.
      Returns:
      the index within this parse text of the last occurrence of the specified string within the specified range, or -1 if the string is not found.

    • length

      int length()
      Returns the length of the parse text.
      Specified by:
      length in interface CharSequence
      Returns:
      the length of the parse text.

    • subSequence

      CharSequence subSequence(int begin, int end)
      Returns a new character sequence that is a subsequence of this sequence.
      Specified by:
      subSequence in interface CharSequence
      Parameters:
      begin - the begin position, inclusive.
      end - the end position, exclusive.
      Returns:
      a new character sequence that is a subsequence of this sequence.

    • toString

      String toString()
      Returns the content of the parse text as a String.
      Specified by:
      toString in interface CharSequence
      Overrides:
      toString in class Object
      Returns:
      the content of the parse text as a String.