Class AbstractEntity

java.lang.Object

com.ibm.wala.cast.ir.translator.AbstractEntity

All Implemented Interfaces:

CAstEntity

Direct Known Subclasses:

AbstractClassEntity, AbstractCodeEntity, AbstractFieldEntity, AbstractGlobalEntity

public abstract class AbstractEntity
extends Object
implements CAstEntity

Field Summary

Fields inherited from interface CAstEntity

FIELD_ENTITY, FILE_ENTITY, FUNCTION_ENTITY, GLOBAL_ENTITY, MACRO_ENTITY, RULE_ENTITY, SCRIPT_ENTITY, SUB_LANGUAGE_BASE, TYPE_ENTITY

Modifier and Type	Field	Description
static final int	FIELD_ENTITY	This entity is a field in an object-oriented language.
static final int	FILE_ENTITY	This entity is a source file (i.e.
static final int	FUNCTION_ENTITY	This entity is a function.
static final int	GLOBAL_ENTITY	This entity represents a global variable
static final int	MACRO_ENTITY	This entity is a macro.
static final int	RULE_ENTITY	This entity represents a rule in a logic language.
static final int	SCRIPT_ENTITY	This entity is a program script for a scripting language.
static final int	SUB_LANGUAGE_BASE	Languages that introduce new kinds of CAstEntity should use this number as the base of integers chosen to denote the new entity types.
static final int	TYPE_ENTITY	This entity is a type in an object-oriented language.

Constructor Summary

Constructors

Constructor	Description
AbstractEntity()

Method Summary

Modifier and Type	Method	Description
void	addScopedEntity(CAstNode construct, CAstEntity child)
Map<CAstNode, @NonNull Collection<CAstEntity>>	getAllScopedEntities()	Some programming language constructs have a lexical structure.
Collection<CAstAnnotation>	getAnnotations()	Returns the set of any annotations this entity may have
CAstSourcePositionMap.Position	getPosition()	The source position of this entity.
Iterator<CAstEntity>	getScopedEntities(CAstNode construct)	Some programming language constructs have a lexical structure.
String	getSignature()	Some programming language constructs have signatures, which are like names but usually have some detail to distinguish the construct from others with the same name.
void	setPosition(CAstSourcePositionMap.Position pos)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface CAstEntity

getArgumentCount, getArgumentDefaults, getArgumentNames, getAST, getControlFlow, getKind, getName, getNamePosition, getNodeTypeMap, getOriginal, getPosition, getQualifiers, getSourceMap, getType

Modifier and Type	Method	Description
int	getArgumentCount()	Some programming language constructs have a specific number of arguments.
CAstNode[]	getArgumentDefaults()	Some programming language constructs allow arguments to have default values.
String[]	getArgumentNames()	Some programming language constructs have named arguments.
CAstNode	getAST()	The CAPA AST of this entity.
CAstControlFlowMap	getControlFlow()	The control flow map for the CAPA AST of this entity.
int	getKind()	What kind of entity is this? The answer should be one of the constants in this file.
String	getName()	Some programming language constructs have names.
CAstSourcePositionMap.Position	getNamePosition()	The source position of the token denoting this entity's name.
CAstNodeTypeMap	getNodeTypeMap()	The map from CAstNodes to types.
default CAstEntity	getOriginal()	Allow finding original entity after rewrites
CAstSourcePositionMap.Position	getPosition(int arg)	The source position of argument 'arg' this entity, if any;
Collection<CAstQualifier>	getQualifiers()	Returns an Iterator over the qualifiers of the given entity, if it has any, e.g., "final", "private".
CAstSourcePositionMap	getSourceMap()	The map of CAstNodes to source positions for the CAPA AST of this entity.
CAstType	getType()	The CAst type of this entity.

Constructor Details

AbstractEntity

public AbstractEntity()

Method Details

getAllScopedEntities

public Map<CAstNode, @NonNull Collection<CAstEntity>> getAllScopedEntities()

Description copied from interface: CAstEntity

Some programming language constructs have a lexical structure. This should be those constructs that are directly inside the current one. The result of this method is a map from source construct to the set of entities induced by that construct. Entities induced by no particular construct are mapped by the null key.

Specified by:

getAllScopedEntities in interface CAstEntity

getSignature

public String getSignature()

Description copied from interface: CAstEntity

Some programming language constructs have signatures, which are like names but usually have some detail to distinguish the construct from others with the same name. Signatures often denote typing information as well, but this is not required. This method should return a signature if appropriate, and null otherwise.

Specified by:

getSignature in interface CAstEntity

getAnnotations

public Collection<CAstAnnotation> getAnnotations()

Description copied from interface: CAstEntity

Returns the set of any annotations this entity may have

Specified by:

getAnnotations in interface CAstEntity

setPosition

public void setPosition(CAstSourcePositionMap.Position pos)

getPosition

public CAstSourcePositionMap.Position getPosition()

Description copied from interface: CAstEntity

The source position of this entity.

Specified by:

getPosition in interface CAstEntity

getScopedEntities

public Iterator<CAstEntity> getScopedEntities(CAstNode construct)

Description copied from interface: CAstEntity

Some programming language constructs have a lexical structure. This should be those constructs that are directly inside the current one. The result of this method is the scoped entities induced by the construct `construct' (i.e. a node of the AST returned by

Enclosed entities not induced by a specific AST node are mapped by the construct 'null'.

Specified by:

getScopedEntities in interface CAstEntity

addScopedEntity

public void addScopedEntity(CAstNode construct,
 CAstEntity child)