com.hp.util.syntax

Class SyntaxPosition

java.lang.Object

java.text.ParsePosition

com.hp.util.syntax.SyntaxPosition

public class SyntaxPosition
extends ParsePosition

Class to hold the offset of an argument on which a parse was attempted and the syntax node against which the parse was attempted.

Author:

Thomas Vachuska, Steve Britt

Constructor Summary

Constructors

Constructor and Description
SyntaxPosition() Constructs a new syntax position object using the offset of -1.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
SyntaxNode	getSyntaxNode() Gets the syntax node with which this position is associated.
int	hashCode()
void	update(ParsePosition position, SyntaxNode node) This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified parse position's error offset is larger than its own.
void	update(ParsePosition position, SyntaxNode node, boolean overrideIfIndicesEqual) This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified parse position's error offset is larger than its own.
void	update(SyntaxPosition position) This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified position's error offset is larger than its own.
boolean	wasUpdated() Determines if the position was updated and resets the update flag to false, thus operating as a reset-on-read latch.

Methods inherited from class java.text.ParsePosition

getErrorIndex, getIndex, setErrorIndex, setIndex, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SyntaxPosition

public SyntaxPosition()

Constructs a new syntax position object using the offset of -1.

Method Detail

getSyntaxNode

public SyntaxNode getSyntaxNode()

Gets the syntax node with which this position is associated.

Returns:

SyntaxNode instance associated with this exception.

update

public void update(SyntaxPosition position)

This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified position's error offset is larger than its own.

Parameters:

position - Original position whose state should be cloned.

update

public void update(ParsePosition position,
                   SyntaxNode node)

This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified parse position's error offset is larger than its own.

Parameters:

position - Original position whose state should be cloned.

node - Node to associate with this position as part of the update.

update

public void update(ParsePosition position,
                   SyntaxNode node,
                   boolean overrideIfIndicesEqual)

This method updates the error offset of this syntax position and it will also update it's own syntax node reference with the specified one, if the specified parse position's error offset is larger than its own. This method is one of several update methods. This version of update is used when a parameter matches. That is very different than when a keyword matches. Because of this the matching algorithm is NOT examined as it is in other update methods.

Parameters:

position - Original position whose state should be cloned.

node - Node to associate with this position as part of the update.

overrideIfIndicesEqual - True if the update should occur even if the indices are equal to each other; false if the update should occur only if the new index is greater than the old one.

wasUpdated

public boolean wasUpdated()

Determines if the position was updated and resets the update flag to false, thus operating as a reset-on-read latch.

Returns:

True if the position was updated; false otherwise.

equals

public boolean equals(Object o)

Overrides:

equals in class ParsePosition

hashCode

public int hashCode()

Overrides:

hashCode in class ParsePosition