A B C D E F G H I K L M N O P R S T V

A

arguments - Variable in class de.weltraumschaf.commons.shell.ShellCommand

Optional arguments.

asBoolean() - Method in class de.weltraumschaf.commons.token.BaseToken.BooleanToken

asBoolean() - Method in class de.weltraumschaf.commons.token.BaseToken.FloatToken

asBoolean() - Method in class de.weltraumschaf.commons.token.BaseToken.IntegerToken

asBoolean() - Method in class de.weltraumschaf.commons.token.BaseToken.StringToken

asBoolean() - Method in interface de.weltraumschaf.commons.token.Token

Get the boolean typed value.

asFloat() - Method in class de.weltraumschaf.commons.token.BaseToken.BooleanToken

asFloat() - Method in class de.weltraumschaf.commons.token.BaseToken.FloatToken

asFloat() - Method in class de.weltraumschaf.commons.token.BaseToken.IntegerToken

asFloat() - Method in class de.weltraumschaf.commons.token.BaseToken.StringToken

asFloat() - Method in interface de.weltraumschaf.commons.token.Token

Get the float typed value.

asInteger() - Method in class de.weltraumschaf.commons.token.BaseToken.BooleanToken

asInteger() - Method in class de.weltraumschaf.commons.token.BaseToken.FloatToken

asInteger() - Method in class de.weltraumschaf.commons.token.BaseToken.IntegerToken

asInteger() - Method in class de.weltraumschaf.commons.token.BaseToken.StringToken

asInteger() - Method in interface de.weltraumschaf.commons.token.Token

Get the integer typed value.

asString() - Method in class de.weltraumschaf.commons.token.BaseToken

Get the string typed value.

asString() - Method in interface de.weltraumschaf.commons.token.Token

Get the string typed value.

B

BaseToken<T> - Class in de.weltraumschaf.commons.token

Base token implementation with generic value.

BaseToken(TokenType, Position, String, T) - Constructor for class de.weltraumschaf.commons.token.BaseToken

Dedicated constructor .

BaseToken.BooleanToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BaseToken.FloatToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BaseToken.IntegerToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BaseToken.KeywordToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BaseToken.LiteralToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BaseToken.StringToken - Class in de.weltraumschaf.commons.token

Concrete implementation of boolean token.

BooleanToken(Position, String, Boolean) - Constructor for class de.weltraumschaf.commons.token.BaseToken.BooleanToken

Dedicated constructor.

C

CharacterHelper - Class in de.weltraumschaf.commons.characters

Helper class to verify if a given character belong to a specified group or range of characters.

CharacterHelper() - Constructor for class de.weltraumschaf.commons.characters.CharacterHelper

Private constructor for pure static utility class.

CharacterStream - Class in de.weltraumschaf.commons.characters

Access a string as stream of characters.

CharacterStream(String) - Constructor for class de.weltraumschaf.commons.characters.CharacterStream

Initializes stream with string.

column - Variable in class de.weltraumschaf.commons.token.Position

Column of occurrence.

commandMap - Variable in class de.weltraumschaf.commons.shell.DefaultParser

Map used to determine command keywords.

commandMap - Variable in class de.weltraumschaf.commons.shell.DefaultScanner

Maps command literal strings to command types.

CommandType - Interface in de.weltraumschaf.commons.shell

Marker interface for shell command types.

CommandVerifier - Interface in de.weltraumschaf.commons.shell

Implementors verifies the passed command.

current() - Method in class de.weltraumschaf.commons.characters.CharacterStream

Returns the current character.

D

de.weltraumschaf.commons.characters - package de.weltraumschaf.commons.characters

Sub package for character handling.

de.weltraumschaf.commons.shell - package de.weltraumschaf.commons.shell

Sub package for a simple interactive shell.

de.weltraumschaf.commons.token - package de.weltraumschaf.commons.token

New designed tokens.

DEFAULT_MSG - Static variable in exception de.weltraumschaf.commons.shell.SyntaxException

Default exception message.

DefaultParser - Class in de.weltraumschaf.commons.shell

Default parses implementation.

DefaultParser(Scanner, CommandVerifier, LiteralCommandMap) - Constructor for class de.weltraumschaf.commons.shell.DefaultParser

Dedicated constructor.

DefaultScanner - Class in de.weltraumschaf.commons.shell

Default implementation for scanning the input line from an interactive shell.

DefaultScanner(LiteralCommandMap) - Constructor for class de.weltraumschaf.commons.shell.DefaultScanner

Dedicated constructor.

defaultSubCommand - Variable in class de.weltraumschaf.commons.shell.LiteralCommandMap

Default sub command for commands w/o sub commands.

determineCommand(Token) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines the appropriate main command type for given string token.

determineSubCommand(Token) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines the appropriate sub command type for given string token.

E

equals(Object) - Method in class de.weltraumschaf.commons.token.BaseToken

equals(Object) - Method in class de.weltraumschaf.commons.token.Position

F

file - Variable in class de.weltraumschaf.commons.token.Position

File of the source string.

FloatToken(Position, String, Float) - Constructor for class de.weltraumschaf.commons.token.BaseToken.FloatToken

Dedicated constructor.

G

getArguments() - Method in class de.weltraumschaf.commons.shell.ShellCommand

Get arguments.

getColumn() - Method in class de.weltraumschaf.commons.token.Position

Returns column of occurrence in source.

getDefaultSubCommand() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Get the default sub command for commands w/o sub commands.

getFile() - Method in class de.weltraumschaf.commons.token.Position

Returns the file name of the source.

getIndex() - Method in class de.weltraumschaf.commons.characters.CharacterStream

Get the current index position.

getLine() - Method in class de.weltraumschaf.commons.token.Position

Returns line of occurrence in source.

getLiteral() - Method in interface de.weltraumschaf.commons.shell.CommandType

Returns the literal string of the command.

getMainCommand() - Method in class de.weltraumschaf.commons.shell.ShellCommand

Get mainCommand main type.

getMainCommandType() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Return here the enum type which declares your main commands.

getPosition() - Method in class de.weltraumschaf.commons.token.BaseToken

Start position of the token.

getPosition() - Method in interface de.weltraumschaf.commons.token.Token

Start position of the token.

getRaw() - Method in class de.weltraumschaf.commons.token.BaseToken

The raw string recognized by the scanner.

getRaw() - Method in interface de.weltraumschaf.commons.token.Token

The raw string recognized by the scanner.

getSubCommand() - Method in class de.weltraumschaf.commons.shell.ShellCommand

Get optional mainCommand sub type.

getSubCommandType() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Return here the enum type which declares your sub commands.

getType() - Method in class de.weltraumschaf.commons.token.BaseToken

Get the token type class.

getType() - Method in interface de.weltraumschaf.commons.token.Token

Get the token type class.

getValue() - Method in class de.weltraumschaf.commons.token.BaseToken

Get the typed value.

H

hashCode() - Method in class de.weltraumschaf.commons.token.BaseToken

hashCode() - Method in class de.weltraumschaf.commons.token.Position

hasNext() - Method in class de.weltraumschaf.commons.characters.CharacterStream

True if there are more characters.

I

index - Variable in class de.weltraumschaf.commons.characters.CharacterStream

Current character position.

init() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Not overideable template method called in constructor.

initMainCommandMap() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Initializes the command map.

initSubCommandMap() - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Initializes the sub command map.

input - Variable in class de.weltraumschaf.commons.characters.CharacterStream

Accessed string.

IntegerToken(Position, String, Integer) - Constructor for class de.weltraumschaf.commons.token.BaseToken.IntegerToken

Dedicated constructor.

isAllowedInFloat(char) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Whether an character is allowed in float literals.

isAlpha(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a letter [a-zA-Z].

isAlphaNum(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a number or alpha [0-9a-zA-Z].

isCharInRange(char, char, char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is inside a given character range (included).

isCommand(Token) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines if the string literal value of the token is a main command.

isCommand(String) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines if the string literal value is a main command.

isDoubleQuote(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a double quote character.

isKeyword(String) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Determines if a token string is a keyword.

isNum(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a number [0-9].

isOperator(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a operator character.

isQuote(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a quote character.

isSign(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a sign character.

isSingleQuote(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a single quote character.

isSpecialChar(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a special character.

isSubCommand(Token) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines if the string literal value of the token is a sub command.

isSubCommand(String) - Method in class de.weltraumschaf.commons.shell.LiteralCommandMap

Determines if the string literal value is a sub command.

isWhiteSpace(char) - Static method in class de.weltraumschaf.commons.characters.CharacterHelper

Checks whether a character is a whitespace.

K

KeywordToken(Position, String, String) - Constructor for class de.weltraumschaf.commons.token.BaseToken.KeywordToken

Dedicated constructor.

L

line - Variable in class de.weltraumschaf.commons.token.Position

Line of occurrence.

LiteralCommandMap - Class in de.weltraumschaf.commons.shell

Maps the literal string of an command to its enum type.

LiteralCommandMap(SubCommandType) - Constructor for class de.weltraumschaf.commons.shell.LiteralCommandMap

Dedicated constructor.

LiteralToken(Position, String, String) - Constructor for class de.weltraumschaf.commons.token.BaseToken.LiteralToken

Dedicated constructor.

M

mainCommand - Variable in class de.weltraumschaf.commons.shell.ShellCommand

Obligatory main command.

mainCommands - Variable in class de.weltraumschaf.commons.shell.LiteralCommandMap

Map the literal command string to corresponding type enum.

MainCommandType - Interface in de.weltraumschaf.commons.shell

Marker interface for shell main command types.

N

newBooleanToken(Position, String, Boolean) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new boolean token.

newFloatToken(Position, String, Float) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new float token.

newIntegerToken(Position, String, Integer) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new integer token.

newKeywordToken(Position, String, String) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new keyword token.

newLiteralToken(Position, String, String) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new literal token.

newParser(LiteralCommandMap) - Static method in class de.weltraumschaf.commons.shell.Parsers

Creates a new parser with default scanner implementation and NullCommandVerifier.

newParser(Scanner, LiteralCommandMap) - Static method in class de.weltraumschaf.commons.shell.Parsers

Create new parser with custom scanner and NullCommandVerifier.

newParser(CommandVerifier, LiteralCommandMap) - Static method in class de.weltraumschaf.commons.shell.Parsers

Creates parser with DefaultScanner.

newParser(Scanner, CommandVerifier, LiteralCommandMap) - Static method in class de.weltraumschaf.commons.shell.Parsers

Creates parser.

newScanner(LiteralCommandMap) - Static method in class de.weltraumschaf.commons.shell.Scanners

Creates a new scanner.

newStringToken(Position, String, String) - Static method in class de.weltraumschaf.commons.token.Tokens

Creates a new string token.

next() - Method in class de.weltraumschaf.commons.characters.CharacterStream

Returns next character.

Null - Class in de.weltraumschaf.commons.token

Represents a null value.

Null() - Constructor for class de.weltraumschaf.commons.token.Null

Hidden to prevent multiple instances.

NULL - Static variable in class de.weltraumschaf.commons.token.Null

The only reusable instance.

NULL - Static variable in class de.weltraumschaf.commons.token.Position

A position for line 0 and column 0.

NullCommandVerifier - Class in de.weltraumschaf.commons.shell

Verifies nothing.

NullCommandVerifier() - Constructor for class de.weltraumschaf.commons.shell.NullCommandVerifier

O

OPERATORS - Static variable in class de.weltraumschaf.commons.characters.CharacterHelper

Operator characters.

P

parse(String) - Method in class de.weltraumschaf.commons.shell.DefaultParser

Parses given input line.

parse(String) - Method in interface de.weltraumschaf.commons.shell.Parser

Parses given input line.

Parser - Interface in de.weltraumschaf.commons.shell

Parses input line from interactive shell.

Parsers - Class in de.weltraumschaf.commons.shell

Factory to create parsers.

Parsers() - Constructor for class de.weltraumschaf.commons.shell.Parsers

Hide constructor for factories sake.

peek() - Method in class de.weltraumschaf.commons.characters.CharacterStream

Look ahead one character w/o advancing the internal pointer for the current character.

position - Variable in class de.weltraumschaf.commons.token.BaseToken

Start position of token.

Position - Class in de.weltraumschaf.commons.token

Represents a token position in the source string.

Position(int, int) - Constructor for class de.weltraumschaf.commons.token.Position

Initializes without file.

Position(int, int, String) - Constructor for class de.weltraumschaf.commons.token.Position

Dedicated constructor initializes immutable object.

R

raw - Variable in class de.weltraumschaf.commons.token.BaseToken

Raw scanned lexeme.

S

scan(String) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Scans give line and returns list of recognized tokens.

scan(List<Token>, CharacterStream) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Loops over all characters of stream.

scan(String) - Method in interface de.weltraumschaf.commons.shell.Scanner

Scans give line and returns list of recognized tokens.

scanFloat(CharacterStream, StringBuilder) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Recognize float tokens until next white space character.

scanLiteral(CharacterStream) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Recognize alpha numeric string tokens until next white space character.

scanLiteralOrKeyword(CharacterStream, StringBuilder) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Recognize alpha numeric string tokens until next white space character.

scanner - Variable in class de.weltraumschaf.commons.shell.DefaultParser

Tokenize the input line.

Scanner - Interface in de.weltraumschaf.commons.shell

Scans the input line from an interactive shell.

Scanners - Class in de.weltraumschaf.commons.shell

Factory to create scanners.

Scanners() - Constructor for class de.weltraumschaf.commons.shell.Scanners

Hide constructor for factories sake.

scanNumber(CharacterStream) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Recognize numeric tokens until next white space character.

scanString(CharacterStream) - Method in class de.weltraumschaf.commons.shell.DefaultScanner

Scan string tokens.

ShellCommand - Class in de.weltraumschaf.commons.shell

Describes a parsed mainCommand of the interactive shell.

ShellCommand(MainCommandType, SubCommandType, List<Token>) - Constructor for class de.weltraumschaf.commons.shell.ShellCommand

Dedicated constructor.

SIGN_CHARS - Static variable in class de.weltraumschaf.commons.characters.CharacterHelper

Number sign characters.

SPECIAL_CHARS - Static variable in class de.weltraumschaf.commons.characters.CharacterHelper

Special characters allowed in literals.

StringToken(Position, String, String) - Constructor for class de.weltraumschaf.commons.token.BaseToken.StringToken

Dedicated constructor.

StringToken(TokenType, Position, String, String) - Constructor for class de.weltraumschaf.commons.token.BaseToken.StringToken

Constructor for sub classes.

subCommand - Variable in class de.weltraumschaf.commons.shell.ShellCommand

Optional sub mainCommand.

subCommands - Variable in class de.weltraumschaf.commons.shell.LiteralCommandMap

Map the literal sub command string to corresponding type enum.

SubCommandType - Interface in de.weltraumschaf.commons.shell

Marker interface for shell sub command types.

SyntaxException - Exception in de.weltraumschaf.commons.shell

Signals syntax errors in the input scanned from an interactive shell.

SyntaxException() - Constructor for exception de.weltraumschaf.commons.shell.SyntaxException

Default constructor.

SyntaxException(String) - Constructor for exception de.weltraumschaf.commons.shell.SyntaxException

Exception with custom error message.

SyntaxException(Throwable) - Constructor for exception de.weltraumschaf.commons.shell.SyntaxException

Exception with default message.

SyntaxException(String, Throwable) - Constructor for exception de.weltraumschaf.commons.shell.SyntaxException

Dedicated constructor.

T

Token - Interface in de.weltraumschaf.commons.token

Defines a token.

Tokens - Class in de.weltraumschaf.commons.token

Factory to create tokens.

Tokens() - Constructor for class de.weltraumschaf.commons.token.Tokens

Hidden for pure static factory.

TokenType - Enum in de.weltraumschaf.commons.token

Defines the token classes.

TokenType() - Constructor for enum de.weltraumschaf.commons.token.TokenType

toString() - Method in class de.weltraumschaf.commons.shell.ShellCommand

toString() - Method in class de.weltraumschaf.commons.token.BaseToken

toString() - Method in class de.weltraumschaf.commons.token.Position

Returns human readable string representation.

type - Variable in class de.weltraumschaf.commons.token.BaseToken

Token class type.

V

value - Variable in class de.weltraumschaf.commons.token.BaseToken

Recognized typed token value.

valueOf(String) - Static method in enum de.weltraumschaf.commons.token.TokenType

Returns the enum constant of this type with the specified name.

values() - Static method in enum de.weltraumschaf.commons.token.TokenType

Returns an array containing the constants of this enum type, in the order they are declared.

verifier - Variable in class de.weltraumschaf.commons.shell.DefaultParser

Verifies the parsed commands.

verifyCommand(ShellCommand) - Method in interface de.weltraumschaf.commons.shell.CommandVerifier

Verifies parsed command of consistency.

verifyCommand(ShellCommand) - Method in class de.weltraumschaf.commons.shell.NullCommandVerifier

Verifies parsed command of consistency.

A B C D E F G H I K L M N O P R S T V