Package io.permazen.cli.parse

Class WordParser

java.lang.Object

io.permazen.cli.parse.WordParser

All Implemented Interfaces:

Parser<String>

public class WordParser
extends Object
implements Parser<String>

Parses a word (one or more characters).

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

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 Details

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(Session session,
 String text)

Description copied from interface: Parser

Parse value from the given text.

Specified by:

parse in interface Parser<String>

Parameters:

session - CLI session

text - input to parse

Returns:

parsed value