Class StringMarcher

Method Details

• length

  public int length()

  Specified by:

  length in interface CharSequence

• charAt

  public char charAt(int index)

  Specified by:

  charAt in interface CharSequence

• subSequence

  public CharSequence subSequence(int start, int end)

  Specified by:

  subSequence in interface CharSequence

• toString

  public String toString()

  Specified by:

  toString in interface CharSequence

  Overrides:

  toString in class Object

• hashCode

  public int hashCode()

  Overrides:

  hashCode in class Object

• equals

  public boolean equals(Object obj)

  Overrides:

  equals in class Object

• getBuilder

  public StringBuilder getBuilder()

  Query the underlying StringBuilder. Any modifications to this builder will be reflected in the StringMarcher.

  Returns:

  data

• getData

  public String getData()

  Query the marchers data.

  Returns:

  the portion of the string that has not been marched through.

• enterScope

  public StringMarcher enterScope()

  Save the current data to a scope. You can then parse the data, discover it does not fit into pattern a, call resetScope(), and check for pattern b.

  Returns:

  this

  See Also:

  • exitScope()
  • resetScope()
  • acceptScope()

• exitScope

  public StringMarcher exitScope() throws NoSuchElementException

  Exit this scope and restore the previous.

  Returns:

  this

  Throws:

  NoSuchElementException - if there are no saved scopes.

  See Also:

  • enterScope()
  • resetScope()
  • acceptScope()

• resetScope

  public StringMarcher resetScope() throws NoSuchElementException

  Reset this scope to the previous without exiting.

  Returns:

  this

  Throws:

  NoSuchElementException - if there are no saved scopes to reset to.

  See Also:

  • exitScope()
  • enterScope()
  • acceptScope()

• acceptScope

  public StringMarcher acceptScope() throws NoSuchElementException

  Mark this scope as successful and discarding the previous scope

  Returns:

  this

  Throws:

  NoSuchElementException

  See Also:

  • exitScope()
  • enterScope()
  • resetScope()

• result

  public String result() throws NoSuchElementException

  Return the result of the last operation. If the last operation has been obtained, use the run before that.

  Returns:

  the result of the last operation whose value has not been obtained.

  Throws:

  NoSuchElementException - if no operations have taken place or their results have already been obtained.

  See Also:

  • success()
  • peek()
  • expect()

• success

  public boolean success() throws NoSuchElementException

  Return if the last unchecked operation succeeded. this will consume the result.

  Returns:

  if the last operation consumed any portion of string, even empty.

  Throws:

  NoSuchElementException - if there are no unmatched operations.

  See Also:

  • result()
  • peek()
  • expect()

• peek

  public String peek() throws NoSuchElementException

  Return the result of the last operation. If the last operation has been obtained, use the run before that. This does not remove the result.

  Returns:

  the result of the last operation whose value has not been obtained.

  Throws:

  NoSuchElementException - if no operations have taken place or their results have already been obtained.

  See Also:

  • result()
  • success()
  • expect()

• expect

  public StringMarcher expect() throws NoSuchElementException, StringMarcher.Backup

  Ensure the last unmatched operation obtained something.

  Returns:

  this

  Throws:

  NoSuchElementException - if there are no unmatched operations.

  StringMarcher.Backup - if the last unchecked operation failed.

  See Also:

  • result()
  • success()
  • peek()

• literal

  public StringMarcher literal(String value)

  Match the literal, or fail if the marcher does not start with the literal.

  Parameters:

  value - the value to try and match.

  Returns:

  this

• next

  public StringMarcher next()

  Match the next character. fail if the marcher is empty.

  Returns:

  this

  See Also:

  • next(int)

• next

  public StringMarcher next(int value)

  Match the next value characters. fail if the marcher's length is less than value.

  Parameters:

  value - the number of characters to match

  Returns:

  this

  See Also:

  • next()

• regexGreedy

  public StringMarcher regexGreedy(String regex)

  Try to match portions of data starting with the entire content and shrinking down to the empty string. If any portions match, remove the largest one. Fail if the regex matches neither a substring starting at 0 nor the empty string.

  Parameters:

  regex - the regex to try and match.

  Returns:

  this

  See Also:

  • regexNonGreedy(String)

• regexNonGreedy

  public StringMarcher regexNonGreedy(String regex)

  Try to match portions of data starting with the empty string and growing up to the entire content. If any portions match, remove the smallest one. Fail if the regex matches neither a substring starting at 0 nor the empty string.

  Parameters:

  regex - the regex to try and match.

  Returns:

  this

  See Also:

  • regexGreedy(String)

• entireString

  public StringMarcher entireString()

  Match and discard the entire data. This operation is guaranteed not to fail.

  Returns:

  this