symbols

Class AbstractSymbol

java.lang.Object

symbols.AbstractSymbol

Direct Known Subclasses:

BracketCloseSymbol, BracketOpenSymbol, ColonSignSymbol, CommentSymbol, EmptySymbol, EndSymbol, EqualSignSymbol, EqualsTildeSymbol, IdentifierSymbol, OptionSymbol, PathSymbol, PlusSymbol, RegExpSymbol, RowEndSymbol, StringSymbol, UnknownSymbol, ValueSymbol, VariableSymbol

public class AbstractSymbol
extends java.lang.Object

This abstract class represents the symbols.

Author:

HFW410

Field Summary

Fields

Modifier and Type	Field and Description
private Position	position This attribute is the position of the symbol.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractSymbol(Position position) This constructor instantiate the Symbol.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Position	getPosition()
int	hashCode()
java.lang.Boolean	isPackageDescriptionFileSymbol()
java.lang.Boolean	isPathSymbol()
java.lang.Boolean	isRowEndSymbol()
java.lang.Boolean	isValueSymbol()
CommentSymbol	toCommentSymbol()
OptionSymbol	toOptionSymbol()
PackageDescriptionFileSymbol	toPackageDescriptionFileSymbol()
PathSymbol	toPathSymbol()
ValueSymbol	toValueSymbol()
VariableSymbol	toVariableSymbol()

Methods inherited from class java.lang.Object

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

Field Detail

position

private final transient Position position

This attribute is the position of the symbol.

Constructor Detail

AbstractSymbol

protected AbstractSymbol(Position position)

This constructor instantiate the Symbol.

Parameters:

position - (row and column) of the data in the datastream. The position of the first sign of the symbol inclusive of the \# or ' etc.

Method Detail

getPosition

public Position getPosition()

Returns:

the position

isValueSymbol

public java.lang.Boolean isValueSymbol()

Returns:

true, if the Symbol is a value symbol.

isPathSymbol

public java.lang.Boolean isPathSymbol()

Returns:

true, if the Symbol is a path symbol.

isRowEndSymbol

public java.lang.Boolean isRowEndSymbol()

Returns:

true, if the Symbol is a row end symbol.

isPackageDescriptionFileSymbol

public java.lang.Boolean isPackageDescriptionFileSymbol()

Returns:

true, if the Symbol is a package description file symbol.

toVariableSymbol

public VariableSymbol toVariableSymbol()

Returns:

an error, if the symbol is not a variable symbol

toValueSymbol

public ValueSymbol toValueSymbol()

Returns:

an error, if the symbol is not a value symbol

toPathSymbol

public PathSymbol toPathSymbol()

Returns:

an error, if the symbol is not a path symbol

toOptionSymbol

public OptionSymbol toOptionSymbol()

Returns:

an error, if the symbol is not an option symbol

toCommentSymbol

public CommentSymbol toCommentSymbol()

Returns:

an error, if the symbol is not a comment symbol

toPackageDescriptionFileSymbol

public PackageDescriptionFileSymbol toPackageDescriptionFileSymbol()

Returns:

a PackageDescriptionFileSymbol or an error, if the symbol is not a package description file symbol.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object