tip.node
Class EOF

java.lang.Object
  extended by tip.node.Node
      extended by tip.node.Token
          extended by tip.node.EOF
All Implemented Interfaces:
Cloneable, NodeInterface

public final class EOF
extends Token

The EOF token represents the end-of-file marker from an input-file.


Constructor Summary
EOF()
          Creates a new EOF token with no line and position information.
EOF(int line, int pos)
          Creates a new EOF token with the given line and position information.
EOF(Token token)
          Creates a new EOF token that is an alias of the given token.
 
Method Summary
 void apply(Analysis caller)
          Calls the Analysis.caseEOF(EOF) of the Analysis caller.
<A> A
apply(Answer<A> caller)
          Returns the answer for caller by applying this EOF node to the Answer visitor.
<Q> void
apply(Question<Q> caller, Q question)
          Applies this EOF node to the Question visitor caller.
<Q,A> A
apply(QuestionAnswer<Q,A> caller, Q question)
          Returns the answer for caller by applying this EOF node with the question to the QuestionAnswer visitor.
 EOF clone()
          Creates a clone of this EOF token.
 EOF clone(Map<Node,Node> oldToNewMap)
          Creates a deep clone of this EOF token while putting all old node-new node relations in the map oldToNewMap.
 TokenEnum kindToken()
          Returns the TokenEnum corresponding to the type of this Token node.
 void setText(String text)
          Implements the Token.setText(String) method.
 
Methods inherited from class tip.node.Token
checkOptionalInvariant, getChildren, getDescendants, getLine, getPos, getText, getToken, kindNode, setLine, setPos, toString
 
Methods inherited from class tip.node.Node
getAncestor, getAncestor, getAncestor, getChildren, getChildren, getDescendants, getDescendants, getDescendants, isOptionalInvariant, parent, replaceBy, setOptionalInvariant
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EOF

public EOF()
Creates a new EOF token with no line and position information.


EOF

public EOF(int line,
           int pos)
Creates a new EOF token with the given line and position information.

Parameters:
line - the line number information for this EOF token
pos - the line position information for this EOF token

EOF

public EOF(Token token)
Creates a new EOF token that is an alias of the given token.

Parameters:
token - the original token for this EOF token
Method Detail

clone

public EOF clone()
Creates a clone of this EOF token.

Specified by:
clone in interface NodeInterface
Specified by:
clone in class Token
Returns:
a clone of this EOF token

clone

public EOF clone(Map<Node,Node> oldToNewMap)
Creates a deep clone of this EOF token while putting all old node-new node relations in the map oldToNewMap.

Specified by:
clone in interface NodeInterface
Specified by:
clone in class Token
Parameters:
oldToNewMap - the map filled with the old node-new node relation
Returns:
a clone of this EOF token

kindToken

public TokenEnum kindToken()
Returns the TokenEnum corresponding to the type of this Token node.

Specified by:
kindToken in class Token
Returns:
the TokenEnum for this node

setText

public void setText(String text)
Implements the Token.setText(String) method. Since EOF represents fixed token, this method throws a RuntimeException.

Overrides:
setText in class Token
Parameters:
text - the new text of this token

apply

public void apply(Analysis caller)
Calls the Analysis.caseEOF(EOF) of the Analysis caller.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
sw - the Analysis to which this EOF node is applied

apply

public <A> A apply(Answer<A> caller)
Returns the answer for caller by applying this EOF node to the Answer visitor.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the Answer to which this node is applied
Returns:
the answer as returned from caller

apply

public <Q> void apply(Question<Q> caller,
                      Q question)
Applies this EOF node to the Question visitor caller.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the Question to which this node is applied
question - the question provided to caller

apply

public <Q,A> A apply(QuestionAnswer<Q,A> caller,
                     Q question)
Returns the answer for caller by applying this EOF node with the question to the QuestionAnswer visitor.

Specified by:
apply in interface NodeInterface
Specified by:
apply in class Node
Parameters:
caller - the QuestionAnswer to which this node is applied
question - the question provided to caller
Returns:
the answer as returned from caller