Package org.checkerframework.afu.scenelib.io

Class ASTRecord

java.lang.Object

org.checkerframework.afu.scenelib.io.ASTRecord

All Implemented Interfaces:

Comparable<ASTRecord>

public class ASTRecord
extends Object
implements Comparable<ASTRecord>

Structure bundling an ASTPath with information about its starting point. Necessary because the ASTPath structure does not include the declaration from which it originates.

Field Summary

Fields

Modifier and Type	Field	Description
final CompilationUnitTree	ast	The AST to which this ASTRecord pertains.
final ASTPath	astPath	Path through AST, from specified declaration to descendant node.
final String	className	Name of the enclosing class declaration.
final String	methodName	Name of the enclosing method declaration, or null if there is none.
final String	varName	Name of the enclosing variable declaration, or null if there is none.

Constructor Summary

Constructors

Constructor	Description
ASTRecord(CompilationUnitTree ast, String className, String methodName, String varName, ASTPath astPath)	Creates a new ASTRecord.

Method Summary

Modifier and Type	Method	Description
int	compareTo(ASTRecord rec)
boolean	equals(Object o)
boolean	equals(ASTRecord astRecord)
ASTRecord	extend(Tree.Kind kind, String sel)
ASTRecord	extend(Tree.Kind kind, String sel, int arg)
ASTRecord	extend(ASTPath.ASTEntry entry)
int	hashCode()
boolean	matches(TreePath treePath)	Returns true if this record identifies the given TreePath.
ASTRecord	newArrayLevel(int depth)
ASTRecord	replacePath(ASTPath newPath)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

ast

public final CompilationUnitTree ast

The AST to which this ASTRecord pertains.

className

public final String className

Name of the enclosing class declaration.

methodName

public final String methodName

Name of the enclosing method declaration, or null if there is none.

varName

public final String varName

Name of the enclosing variable declaration, or null if there is none.

astPath

public final ASTPath astPath

Path through AST, from specified declaration to descendant node.

Constructor Details

ASTRecord

public ASTRecord(CompilationUnitTree ast,
 String className,
 String methodName,
 String varName,
 ASTPath astPath)

Creates a new ASTRecord.

Parameters:

ast - the AST to which this ASTRecord pertains

className - name of the enclosing class declaration

methodName - name of the enclosing method declaration, or null if there is none

varName - name of the enclosing variable declaration, or null if there is none

astPath - path through AST, from specified declaration to descendant node

Method Details

newArrayLevel

public ASTRecord newArrayLevel(int depth)

replacePath

public ASTRecord replacePath(ASTPath newPath)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equals

public boolean equals(ASTRecord astRecord)

compareTo

public int compareTo(ASTRecord rec)

Specified by:

compareTo in interface Comparable<ASTRecord>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

matches

public boolean matches(TreePath treePath)

Returns true if this record identifies the given TreePath.

toString

public String toString()

Overrides:

toString in class Object

extend

public ASTRecord extend(ASTPath.ASTEntry entry)

extend

public ASTRecord extend(Tree.Kind kind,
 String sel)

extend

public ASTRecord extend(Tree.Kind kind,
 String sel,
 int arg)