Package org.checkerframework.afu.scenelib.io

Class ASTPath

java.lang.Object

org.checkerframework.afu.scenelib.io.ASTPath

All Implemented Interfaces:

Comparable<ASTPath>, Iterable<ASTPath.ASTEntry>

public class ASTPath
extends Object
implements Comparable<ASTPath>, Iterable<ASTPath.ASTEntry>

A path through the AST.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ASTPath.ASTEntry	A single entry in an AST path.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ANNOTATION
static final String	ARGUMENT
static final String	BLOCK
static final String	BODY
static final String	BOUND
static final String	CASE
static final String	CATCH
static final String	CLASS_BODY
static final String	CONDITION
static final String	DETAIL
static final String	DIMENSION
static final String	ELSE_STATEMENT
static final String	ENCLOSING_EXPRESSION
static final String	EXPRESSION
static final String	FALSE_EXPRESSION
static final String	FINALLY_BLOCK
static final String	IDENTIFIER
static final String	INDEX
static final String	INITIALIZER
static final String	LEFT_OPERAND
static final String	METHOD_SELECT
static final String	MODIFIERS
static final String	PARAMETER
static final String	QUALIFIER_EXPRESSION
static final String	RESOURCE
static final String	RIGHT_OPERAND
static final String	STATEMENT
static final String	THEN_STATEMENT
static final String	THROWS
static final String	TRUE_EXPRESSION
static final String	TYPE
static final String	TYPE_ALTERNATIVE
static final String	TYPE_ARGUMENT
static final String	TYPE_PARAMETER
static final String	UNDERLYING_TYPE
static final String	UPDATE
static final String	VARIABLE

Method Summary

Modifier and Type	Method	Description
ASTPath	add(ASTPath.ASTEntry entry)
int	compareTo(ASTPath o)
static ASTPath	empty()
boolean	equals(Object o)
boolean	equals(ASTPath astPath)
ASTPath	extend(ASTPath.ASTEntry entry)
ASTPath	extendNewArray(int depth)
ASTPath.ASTEntry	get(int index)	Returns the index-th element of this stack.
static Comparator<ASTPath>	getComparator()
ASTPath.ASTEntry	getLast()
ASTPath	getParentPath()
int	hashCode()
static boolean	isBinaryOperator(Tree.Kind kind)	Determines if the given kind is a binary operator.
static boolean	isClassEquiv(Tree.Kind kind)
static boolean	isCompoundAssignment(Tree.Kind kind)	Determines if the given kind is a compound assignment.
static boolean	isDeclaration(Tree.Kind kind)	Determines if the given kind is a declaration.
boolean	isEmpty()	Returns true if the stack is empty.
static boolean	isHandled(Tree.Kind kind)	Returns true if an ASTPath can identify nodes of the given kind.
static boolean	isLiteral(Tree.Kind kind)
static boolean	isTypeKind(Tree.Kind kind)
static boolean	isTypeSelector(String selector)
static boolean	isUnaryOperator(Tree.Kind kind)	Determines if the given kind is a unary operator.
static boolean	isWildcard(Tree.Kind kind)	Determines if the given kind is a wildcard.
Iterator<ASTPath.ASTEntry>	iterator()
boolean	matches(TreePath treePath)	Returns true if this ASTPath matches a given TreePath.
ASTPath	newArrayLevel(int depth)
static ASTPath	parse(String s)	Create a new ASTPath from a formatted string description.
ASTPath.ASTEntry	peek()	Returns the top element of the stack, without modifying the stack.
org.checkerframework.afu.scenelib.io.ImmutableStack<ASTPath.ASTEntry>	pop()	Returns all of the stack except the top element.
org.checkerframework.afu.scenelib.io.ImmutableStack<ASTPath.ASTEntry>	push(ASTPath.ASTEntry elem)
int	size()	Returns the size: the number of elements in the stack.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

ANNOTATION

public static final String ANNOTATION

See Also:

• Constant Field Values

ARGUMENT

public static final String ARGUMENT

See Also:

• Constant Field Values

BLOCK

public static final String BLOCK

See Also:

• Constant Field Values

BODY

public static final String BODY

See Also:

• Constant Field Values

BOUND

public static final String BOUND

See Also:

• Constant Field Values

CASE

public static final String CASE

See Also:

• Constant Field Values

CATCH

public static final String CATCH

See Also:

• Constant Field Values

CLASS_BODY

public static final String CLASS_BODY

See Also:

• Constant Field Values

CONDITION

public static final String CONDITION

See Also:

• Constant Field Values

DETAIL

public static final String DETAIL

See Also:

• Constant Field Values

DIMENSION

public static final String DIMENSION

See Also:

• Constant Field Values

ELSE_STATEMENT

public static final String ELSE_STATEMENT

See Also:

• Constant Field Values

ENCLOSING_EXPRESSION

public static final String ENCLOSING_EXPRESSION

See Also:

• Constant Field Values

EXPRESSION

public static final String EXPRESSION

See Also:

• Constant Field Values

FALSE_EXPRESSION

public static final String FALSE_EXPRESSION

See Also:

• Constant Field Values

FINALLY_BLOCK

public static final String FINALLY_BLOCK

See Also:

• Constant Field Values

IDENTIFIER

public static final String IDENTIFIER

See Also:

• Constant Field Values

INDEX

public static final String INDEX

See Also:

• Constant Field Values

INITIALIZER

public static final String INITIALIZER

See Also:

• Constant Field Values

LEFT_OPERAND

public static final String LEFT_OPERAND

See Also:

• Constant Field Values

METHOD_SELECT

public static final String METHOD_SELECT

See Also:

• Constant Field Values

MODIFIERS

public static final String MODIFIERS

See Also:

• Constant Field Values

PARAMETER

public static final String PARAMETER

See Also:

• Constant Field Values

QUALIFIER_EXPRESSION

public static final String QUALIFIER_EXPRESSION

See Also:

• Constant Field Values

RESOURCE

public static final String RESOURCE

See Also:

• Constant Field Values

RIGHT_OPERAND

public static final String RIGHT_OPERAND

See Also:

• Constant Field Values

STATEMENT

public static final String STATEMENT

See Also:

• Constant Field Values

THEN_STATEMENT

public static final String THEN_STATEMENT

See Also:

• Constant Field Values

THROWS

public static final String THROWS

See Also:

• Constant Field Values

TRUE_EXPRESSION

public static final String TRUE_EXPRESSION

See Also:

• Constant Field Values

TYPE

public static final String TYPE

See Also:

• Constant Field Values

TYPE_ALTERNATIVE

public static final String TYPE_ALTERNATIVE

See Also:

• Constant Field Values

TYPE_ARGUMENT

public static final String TYPE_ARGUMENT

See Also:

• Constant Field Values

TYPE_PARAMETER

public static final String TYPE_PARAMETER

See Also:

• Constant Field Values

UNDERLYING_TYPE

public static final String UNDERLYING_TYPE

See Also:

• Constant Field Values

UPDATE

public static final String UPDATE

See Also:

• Constant Field Values

VARIABLE

public static final String VARIABLE

See Also:

• Constant Field Values

Method Details

empty

public static ASTPath empty()

getComparator

public static Comparator<ASTPath> getComparator()

iterator

public Iterator<ASTPath.ASTEntry> iterator()

Specified by:

iterator in interface Iterable<ASTPath.ASTEntry>

extendNewArray

public ASTPath extendNewArray(int depth)

newArrayLevel

public ASTPath newArrayLevel(int depth)

add

public ASTPath add(ASTPath.ASTEntry entry)

extend

public ASTPath extend(ASTPath.ASTEntry entry)

getParentPath

public ASTPath getParentPath()

getLast

public ASTPath.ASTEntry getLast()

parse

public static ASTPath parse(String s)
                     throws ParseException

Create a new ASTPath from a formatted string description.

Parameters:

s - formatted string as in JAIF insert-\{cast,annotation\}

Returns:

the corresponding ASTPath

Throws:

ParseException - if there is trouble parsing the string

matches

public boolean matches(TreePath treePath)

Returns true if this ASTPath matches a given TreePath.

isTypeSelector

public static boolean isTypeSelector(String selector)

isClassEquiv

public static boolean isClassEquiv(Tree.Kind kind)

isCompoundAssignment

public static boolean isCompoundAssignment(Tree.Kind kind)

Determines if the given kind is a compound assignment.

Parameters:

kind - the kind to test

Returns:

true if the given kind is a compound assignment

isUnaryOperator

public static boolean isUnaryOperator(Tree.Kind kind)

Determines if the given kind is a unary operator.

Parameters:

kind - the kind to test

Returns:

true if the given kind is a unary operator

isBinaryOperator

public static boolean isBinaryOperator(Tree.Kind kind)

Determines if the given kind is a binary operator.

Parameters:

kind - the kind to test

Returns:

true if the given kind is a binary operator

isLiteral

public static boolean isLiteral(Tree.Kind kind)

isTypeKind

public static boolean isTypeKind(Tree.Kind kind)

isWildcard

public static boolean isWildcard(Tree.Kind kind)

Determines if the given kind is a wildcard.

Parameters:

kind - the kind to test

Returns:

true if the given kind is a wildcard

isDeclaration

public static boolean isDeclaration(Tree.Kind kind)

Determines if the given kind is a declaration.

Parameters:

kind - the kind to test

Returns:

true if the given kind is a declaration

isHandled

public static boolean isHandled(Tree.Kind kind)

Returns true if an ASTPath can identify nodes of the given kind.

Parameters:

kind - the kind to test

Returns:

true if the given kind can be identified by an ASTPath

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(ASTPath astPath)

compareTo

public int compareTo(ASTPath o)

Specified by:

compareTo in interface Comparable<ASTPath>

toString

public String toString()

isEmpty

public boolean isEmpty()

Returns true if the stack is empty.

Returns:

true if the stack is empty

peek

public ASTPath.ASTEntry peek()

Returns the top element of the stack, without modifying the stack.

Returns:

the top element of the stack

Throws:

IllegalStateException - if the stack is empty

pop

public org.checkerframework.afu.scenelib.io.ImmutableStack<ASTPath.ASTEntry> pop()

Returns all of the stack except the top element.

Returns:

all of the stack except the top element

Throws:

IllegalStateException - if the stack is empty

push

public org.checkerframework.afu.scenelib.io.ImmutableStack<ASTPath.ASTEntry> push(ASTPath.ASTEntry elem)

size

public int size()

Returns the size: the number of elements in the stack.

Returns:

the size of this stack

get

public ASTPath.ASTEntry get(int index)

Returns the index-th element of this stack.

Parameters:

index - which element to return

Returns:

the index-th element of this stack

Throws:

NoSuchElementException - if the index is out of bounds