parser

Class DefinitionFileParser

java.lang.Object

parser.AbstractFileParser

parser.DefinitionFileParser

public final class DefinitionFileParser
extends AbstractFileParser

Author:

hfw410wi - Mark Wittig

Field Summary

Fields

Modifier and Type	Field and Description
private DefinitionFile	definitionFile The final DedinitionFile.
private static java.lang.String	OPT_STRING the OPT regex.
private java.util.Map<java.lang.String,Opt>	optList the Opts List.
private RouterSoftware	rs The associated RouterSoftware.
private AbstractDefinitionState	state State of the Parser.
private TempVariableDefinition	tVD Temporary Object, which is used to fill the final object when every information is collected.
private java.util.Map<java.lang.String,AbstractVariableDefinition>	vDL List of VariableDefinitions.

Constructor Summary

Constructors

Constructor and Description
DefinitionFileParser(RouterSoftware rs, Buffer<AbstractSymbol> buffer) The DefinitionFileParser will automatically generate a DefinitionFile after instantiation which can be obtained via getDefinitionFile().

Method Summary

Modifier and Type	Method and Description
private Opt	createOpt(AbstractVariableDefinition aVD) yet another totally senseless function for PMD to be quiet.
private VariableDefinitionArray	createVDA(java.lang.String name, AbstractVariableType type, boolean isOptional, boolean isReallyOptional, DefaultValue defaultValue, VariableOptReference reference, AbstractVariableDefinition variableN, Position position) yet another totally senseless function for PMD to be quiet.
private VariableDefinitionSingle	createVDS(java.lang.String name, AbstractVariableType type, boolean isOptional, boolean isReallyOptional, DefaultValue defaultValue, VariableOptReference reference, Position position) yet another totally senseless function for PMD to be quiet.
DefinitionFile	getDefinitionFile() Returns the desired DefinitionFile which is automatically created right after instantiation.
java.util.Map<java.lang.String,Opt>	getOptList()
private AbstractDefinitionState	getState()
java.util.Map<java.lang.String,AbstractVariableDefinition>	getVariableDefinitionList()
private DefinitionFile	parse() parses the whole definition file and writes the result into the definitionFile attribute.
void	setState(AbstractDefinitionState state)

Methods inherited from class parser.AbstractFileParser

getBuffer, getComments, isFinished, setComments, setFinished

Methods inherited from class java.lang.Object

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

Field Detail

rs

private final RouterSoftware rs

The associated RouterSoftware.

state

private transient AbstractDefinitionState state

State of the Parser.

tVD

private final transient TempVariableDefinition tVD

Temporary Object, which is used to fill the final object when every information is collected.

vDL

private final transient java.util.Map<java.lang.String,AbstractVariableDefinition> vDL

List of VariableDefinitions.

optList

private final transient java.util.Map<java.lang.String,Opt> optList

the Opts List.

definitionFile

private final transient DefinitionFile definitionFile

The final DedinitionFile.

OPT_STRING

private static final java.lang.String OPT_STRING

the OPT regex.

See Also:

Constant Field Values

Constructor Detail

DefinitionFileParser

public DefinitionFileParser(RouterSoftware rs,
                            Buffer<AbstractSymbol> buffer)
                     throws java.lang.InterruptedException,
                            ParserException

The DefinitionFileParser will automatically generate a DefinitionFile after instantiation which can be obtained via getDefinitionFile().

Parameters:

rs - The RouterSoftware to use.

buffer - Buffer

Throws:

ParserException - ParserExcpetion

java.lang.InterruptedException - InterruptedException

Method Detail

parse

private DefinitionFile parse()
                      throws java.lang.InterruptedException,
                             ParserException

parses the whole definition file and writes the result into the definitionFile attribute.

Returns:

DefinitionFile

Throws:

java.lang.InterruptedException - InterruptedException

ParserException - ParserException

createVDA

private VariableDefinitionArray createVDA(java.lang.String name,
                                          AbstractVariableType type,
                                          boolean isOptional,
                                          boolean isReallyOptional,
                                          DefaultValue defaultValue,
                                          VariableOptReference reference,
                                          AbstractVariableDefinition variableN,
                                          Position position)

yet another totally senseless function for PMD to be quiet. Suppresses "Avoid instantiating new objects inside loops" warning.

Parameters:

name - name

type - type

isOptional - isOptional

isReallyOptional - isReallyOptional

defaultValue - defaultValue

reference - reference

variableN - variableN

position - position

Returns:

VariableDefinitionArray

createVDS

private VariableDefinitionSingle createVDS(java.lang.String name,
                                           AbstractVariableType type,
                                           boolean isOptional,
                                           boolean isReallyOptional,
                                           DefaultValue defaultValue,
                                           VariableOptReference reference,
                                           Position position)

yet another totally senseless function for PMD to be quiet. Suppresses "Avoid instantiating new objects inside loops" warning.

Parameters:

name - name

type - type

isOptional - isOptional

isReallyOptional - isReallyOptional

defaultValue - defaultValue

reference - reference

position - position

Returns:

VariableDefinitionSingle

createOpt

private Opt createOpt(AbstractVariableDefinition aVD)

yet another totally senseless function for PMD to be quiet. Suppresses "Avoid instantiating new objects inside loops" warning.

Parameters:

aVD - AbstractVariableDefinition

Returns:

Opt

getState

private AbstractDefinitionState getState()

Returns:

the state

setState

public void setState(AbstractDefinitionState state)

Parameters:

state - the state to set

getVariableDefinitionList

public java.util.Map<java.lang.String,AbstractVariableDefinition> getVariableDefinitionList()

Returns:

the variableDefinitionList

getDefinitionFile

public DefinitionFile getDefinitionFile()

Returns the desired DefinitionFile which is automatically created right after instantiation.

Returns:

the definitionFile

getOptList

public java.util.Map<java.lang.String,Opt> getOptList()

Returns:

the optList