com.aspc.commander.parser

Interface Parser

All Known Implementing Classes:

SQLParser, XMLParser

public interface Parser

Parse SQL like statements to implement in terms of DBObjects
THREAD MODE: SINGLE-THREADED

Since:

3 December 2003

Author:

Nigel Leck

Method Summary

Modifier and Type	Method and Description
java.lang.String[]	getList(java.lang.String name) Gets the list of values
java.lang.String	getRawText() Gets the raw text of this command
java.lang.String	getType() Gets the type of the parsed command
java.lang.String	getVariable(java.lang.String name) Gets the String value
java.lang.String	getVariable(java.lang.String name, java.lang.String defaultValue) Gets the String value
int	getVariableInt(java.lang.String name, int defaultValue) Gets the integer value
long	getVariableLong(java.lang.String name, long defaultValue) Gets the long value
boolean	hasKeyWord(java.lang.String word) Does this parsed command have the given key word
void	parse(java.lang.String text) Parses the given command

Method Detail

getType

@CheckReturnValue
 @Nonnull
java.lang.String getType()

Gets the type of the parsed command

Returns:

String the type of the command

hasKeyWord

@CheckReturnValue
boolean hasKeyWord(@Nonnull
                                     java.lang.String word)
                              throws java.lang.Exception

Does this parsed command have the given key word

Parameters:

word - the key word to check for

Returns:

boolean true if this command has the given keyword

Throws:

java.lang.Exception - a serious problem

parse

void parse(@Nonnull
           java.lang.String text)
    throws java.lang.Exception

Parses the given command

Parameters:

text - the command to parse

Throws:

java.lang.Exception - a serious problem

getRawText

@CheckReturnValue
 @Nonnull
java.lang.String getRawText()

Gets the raw text of this command

Returns:

String the raw text of this command

getVariableInt

@CheckReturnValue
int getVariableInt(@Nonnull
                                     java.lang.String name,
                                     int defaultValue)
                              throws java.lang.Exception

Gets the integer value

Parameters:

name - the variable to get

defaultValue - default value if variable is blank

Returns:

int the value

Throws:

java.lang.Exception - a serious problem

getVariableLong

@CheckReturnValue
long getVariableLong(@Nonnull
                                       java.lang.String name,
                                       long defaultValue)
                                throws java.lang.Exception

Gets the long value

Parameters:

name - the variable to get

defaultValue - the default value if the variable is blank

Returns:

long the value

Throws:

java.lang.Exception - a serious problem

getVariable

@CheckReturnValue
 @Nullable
java.lang.String getVariable(@Nonnull
                                                          java.lang.String name,
                                                          @Nullable
                                                          java.lang.String defaultValue)
                                                   throws java.lang.Exception

Gets the String value

Parameters:

name - the variable to get

defaultValue - the defaultValue if the variable is blank

Returns:

String the value

Throws:

java.lang.Exception - a serious problem

getVariable

@CheckReturnValue
 @Nullable
java.lang.String getVariable(@Nonnull
                                                          java.lang.String name)
                                                   throws java.lang.Exception

Gets the String value

Parameters:

name - the variable to get

Returns:

String the value, which can be blank

Throws:

java.lang.Exception - a serious problem

getList

@CheckReturnValue
 @Nonnull
java.lang.String[] getList(@Nonnull
                                                       java.lang.String name)
                                                throws java.lang.Exception

Gets the list of values

Parameters:

name - the variable to get

Returns:

String[] the list of values

Throws:

java.lang.Exception - a serious problem