Package org.petitparser.parser.primitive

Class CharacterParser

java.lang.Object

org.petitparser.parser.Parser

org.petitparser.parser.primitive.CharacterParser

public class CharacterParser
extends Parser

Parses a single character.

Method Summary

Modifier and Type	Method	Description
static CharacterParser	any()	Returns a parser that accepts any character.
static CharacterParser	any(String message)
static CharacterParser	anyOf(String chars)	Returns a parser that accepts any of the provided characters.
static CharacterParser	anyOf(String chars, String message)
CharacterParser	copy()	Returns a shallow copy of the receiver.
static CharacterParser	digit()	Returns a parser that accepts a single digit.
static CharacterParser	digit(String message)
protected boolean	hasEqualProperties(Parser other)	Compares the properties of two parsers.
static CharacterParser	letter()	Returns a parser that accepts a single letter.
static CharacterParser	letter(String message)
static CharacterParser	lowerCase()	Returns a parser that accepts an lower-case letter.
static CharacterParser	lowerCase(String message)
CharacterParser	neg(String message)	Returns a parser that consumes any input token (character), but the receiver.
static CharacterParser	none()	Returns a parser that accepts no character.
static CharacterParser	none(String message)
static CharacterParser	noneOf(String chars)	Returns a parser that accepts none of the provided characters.
static CharacterParser	noneOf(String chars, String message)
static CharacterParser	of(char character)	Returns a parser that accepts a specific character.
static CharacterParser	of(char character, String message)
static CharacterParser	of(CharacterPredicate predicate, String message)	Returns a parser that accepts a specific CharacterPredicate.
Result	parseOn(Context context)	Primitive method doing the actual parsing.
static CharacterParser	pattern(String pattern)	Returns a parser that accepts a specific character pattern.
static CharacterParser	pattern(String pattern, String message)
static CharacterParser	range(char start, char stop)	Returns a parser that accepts a specific character range.
static CharacterParser	range(char start, char stop, String message)
String	toString()	Returns a human readable string identifying this parser.
static CharacterParser	upperCase()	Returns a parser that accepts an upper-case letter.
static CharacterParser	upperCase(String message)
static CharacterParser	whitespace()	Returns a parser that accepts a single whitespace.
static CharacterParser	whitespace(String message)
static CharacterParser	word()	Returns a parser that accepts a single letter or digit.
static CharacterParser	word(String message)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from class org.petitparser.parser.Parser

accept, and, callCC, delimitedBy, end, end, flatten, getChildren, hasEqualChildren, isEqualTo, isEqualTo, map, matches, matchesSkipping, neg, not, not, optional, optional, or, parse, permute, pick, plus, plusGreedy, plusLazy, repeat, repeatGreedy, repeatLazy, replace, separatedBy, seq, settable, star, starGreedy, starLazy, times, token, trim, trim, trim

Method Detail

of

public static CharacterParser of(CharacterPredicate predicate,
                                 String message)

Returns a parser that accepts a specific CharacterPredicate.

of

public static CharacterParser of(char character)

Returns a parser that accepts a specific character.

of

public static CharacterParser of(char character,
                                 String message)

any

public static CharacterParser any()

Returns a parser that accepts any character.

any

public static CharacterParser any(String message)

anyOf

public static CharacterParser anyOf(String chars)

Returns a parser that accepts any of the provided characters.

anyOf

public static CharacterParser anyOf(String chars,
                                    String message)

none

public static CharacterParser none()

Returns a parser that accepts no character.

none

public static CharacterParser none(String message)

noneOf

public static CharacterParser noneOf(String chars)

Returns a parser that accepts none of the provided characters.

noneOf

public static CharacterParser noneOf(String chars,
                                     String message)

digit

public static CharacterParser digit()

Returns a parser that accepts a single digit.

digit

public static CharacterParser digit(String message)

letter

public static CharacterParser letter()

Returns a parser that accepts a single letter.

letter

public static CharacterParser letter(String message)

lowerCase

public static CharacterParser lowerCase()

Returns a parser that accepts an lower-case letter.

lowerCase

public static CharacterParser lowerCase(String message)

pattern

public static CharacterParser pattern(String pattern)

Returns a parser that accepts a specific character pattern.

Characters match themselves. A dash - between two characters matches the range of those characters. A caret ^ at the beginning negates the pattern.

pattern

public static CharacterParser pattern(String pattern,
                                      String message)

range

public static CharacterParser range(char start,
                                    char stop)

Returns a parser that accepts a specific character range.

range

public static CharacterParser range(char start,
                                    char stop,
                                    String message)

upperCase

public static CharacterParser upperCase()

Returns a parser that accepts an upper-case letter.

upperCase

public static CharacterParser upperCase(String message)

whitespace

public static CharacterParser whitespace()

Returns a parser that accepts a single whitespace.

whitespace

public static CharacterParser whitespace(String message)

word

public static CharacterParser word()

Returns a parser that accepts a single letter or digit.

word

public static CharacterParser word(String message)

parseOn

public Result parseOn(Context context)

Description copied from class: Parser

Primitive method doing the actual parsing.

Specified by:

parseOn in class Parser

neg

public CharacterParser neg(String message)

Description copied from class: Parser

Returns a parser that consumes any input token (character), but the receiver.

Overrides:

neg in class Parser

hasEqualProperties

protected boolean hasEqualProperties(Parser other)

Description copied from class: Parser

Compares the properties of two parsers. Override this method in all subclasses that add new state.

Overrides:

hasEqualProperties in class Parser

copy

public CharacterParser copy()

Description copied from class: Parser

Returns a shallow copy of the receiver.

Specified by:

copy in class Parser

toString

public String toString()

Description copied from class: Parser

Returns a human readable string identifying this parser.

Overrides:

toString in class Parser