org.jsimpledb.parse

Class WordParser

java.lang.Object

org.jsimpledb.parse.WordParser

All Implemented Interfaces:

Parser<String>

public class WordParser
extends Object
implements Parser<String>

Parses a word (one or more non-whitespace characters).

Constructor Summary

Constructors

Constructor and Description
WordParser(Collection<String> words, String description) Constructor for when there's a fixed set of possibilities.
WordParser(String description) Constructor when any word is acceptable.

Method Summary

Modifier and Type	Method and Description
protected Collection<String>	getWords() Get the set of valid words, if there is such a set.
String	parse(ParseSession session, ParseContext ctx, boolean complete) Parse text from the given parse context.

Methods inherited from class java.lang.Object

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

Constructor Detail

WordParser

public WordParser(Collection<String> words,
                  String description)

Constructor for when there's a fixed set of possibilities.

Parameters:

words - words to look for

description - what to call words (e.g., "command")

Throws:

IllegalArgumentException - if words is null

IllegalArgumentException - if description is null

WordParser

public WordParser(String description)

Constructor when any word is acceptable.

Parameters:

description - what to call words (e.g., "command")

Throws:

IllegalArgumentException - if words is null

IllegalArgumentException - if description is null

Method Detail

getWords

protected Collection<String> getWords()

Get the set of valid words, if there is such a set.

The implementation in WordParser returns the collection provided to the constructor, if any.

Returns:

collection of valid words, or null to not place any restriction

parse

public String parse(ParseSession session,
                    ParseContext ctx,
                    boolean complete)

Description copied from interface: Parser

Parse text from the given parse context.

Generally speaking, this method may assume that any whitespace allowed before the item being parsed has already been skipped over (that's a matter for the containing parser).

Specified by:

parse in interface Parser<String>

Parameters:

session - parse session

ctx - input to parse

complete - false if parse is "for real", true if only for tab completion calculation

Returns:

parsed value