symbols

Class CommentSymbol

java.lang.Object

symbols.AbstractSymbol

symbols.CommentSymbol

All Implemented Interfaces:

PackageDescriptionFileSymbol

public class CommentSymbol
extends AbstractSymbol
implements PackageDescriptionFileSymbol

This class represents the Symbol of a Comment.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	text This attribute is commenttext.

Constructor Summary

Constructors

Constructor and Description
CommentSymbol(java.lang.String text, Position position) This constructor instantiate a new CommentSymbol with @param text.

Method Summary

Modifier and Type	Method and Description
AbstractPackageParserState	accept(PackageDescriptionSymbolVisitor visitor, PackageDescriptionFileParser parser) calls the visitor with the Symbollist.
AbstractPackageParserState	accept(PackageDescriptionSymbolVisitorWithTempRule visitor, PackageDescriptionFileParser parser, TempPackageRule tempPackageRule) calls the visitor with the Symbollist.
boolean	equals(java.lang.Object obj)
java.lang.String	getText()
int	hashCode()
java.lang.Boolean	isPackageDescriptionFileSymbol()
CommentSymbol	toCommentSymbol()
PackageDescriptionFileSymbol	toPackageDescriptionFileSymbol()
java.lang.String	toString()

Methods inherited from class symbols.AbstractSymbol

getPosition, isPathSymbol, isRowEndSymbol, isValueSymbol, toOptionSymbol, toPathSymbol, toValueSymbol, toVariableSymbol

Methods inherited from class java.lang.Object

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

Methods inherited from interface symbols.PackageDescriptionFileSymbol

getPosition, isPathSymbol, isRowEndSymbol, isValueSymbol, toOptionSymbol, toPathSymbol, toValueSymbol, toVariableSymbol

Field Detail

text

private final transient java.lang.String text

This attribute is commenttext.

Constructor Detail

CommentSymbol

public CommentSymbol(java.lang.String text,
                     Position position)

This constructor instantiate a new CommentSymbol with @param text.

Parameters:

text - is the text of the comment.

position - is the position of the data in the stream.

Method Detail

getText

public java.lang.String getText()

Returns:

the commenttext.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class AbstractSymbol

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractSymbol

accept

public AbstractPackageParserState accept(PackageDescriptionSymbolVisitor visitor,
                                         PackageDescriptionFileParser parser)
                                  throws java.lang.InterruptedException,
                                         ParserException

Description copied from interface: PackageDescriptionFileSymbol

calls the visitor with the Symbollist.

Specified by:

accept in interface PackageDescriptionFileSymbol

Parameters:

visitor - is the called visitor.

parser - This is the PackageDescriptionparser.

Returns:

the actual state of the parser.

Throws:

java.lang.InterruptedException - from the Buffer.

ParserException - if the symbol is not expected.

accept

public AbstractPackageParserState accept(PackageDescriptionSymbolVisitorWithTempRule visitor,
                                         PackageDescriptionFileParser parser,
                                         TempPackageRule tempPackageRule)
                                  throws java.lang.InterruptedException,
                                         ParserException

Description copied from interface: PackageDescriptionFileSymbol

calls the visitor with the Symbollist.

Specified by:

accept in interface PackageDescriptionFileSymbol

Parameters:

visitor - is the called visitor.

parser - This is the PackageDescriptionparser.

tempPackageRule - is a temporary package rule.

Returns:

the actual state of the parser.

Throws:

java.lang.InterruptedException - from the Buffer.

ParserException - if the symbol is not expected.

isPackageDescriptionFileSymbol

public java.lang.Boolean isPackageDescriptionFileSymbol()

Specified by:

isPackageDescriptionFileSymbol in interface PackageDescriptionFileSymbol

Overrides:

isPackageDescriptionFileSymbol in class AbstractSymbol

Returns:

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

toCommentSymbol

public CommentSymbol toCommentSymbol()

Specified by:

toCommentSymbol in interface PackageDescriptionFileSymbol

Overrides:

toCommentSymbol in class AbstractSymbol

Returns:

an error, if the symbol is not a comment symbol

toPackageDescriptionFileSymbol

public PackageDescriptionFileSymbol toPackageDescriptionFileSymbol()

Specified by:

toPackageDescriptionFileSymbol in interface PackageDescriptionFileSymbol

Overrides:

toPackageDescriptionFileSymbol in class AbstractSymbol

Returns:

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