Class AbstractFieldEntity

java.lang.Object

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

com.ibm.wala.cast.ir.translator.AbstractFieldEntity

All Implemented Interfaces:

CAstEntity

public abstract class AbstractFieldEntity
extends AbstractEntity

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
AbstractFieldEntity(String name, Set<CAstQualifier> modifiers, boolean isStatic, CAstEntity declaringClass)

Method Summary

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.
CAstNodeTypeMap	getNodeTypeMap()	The map from CAstNodes to types.
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.
String	toString()

Methods inherited from class AbstractEntity

addScopedEntity, getAllScopedEntities, getAnnotations, getPosition, getScopedEntities, getSignature, setPosition

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, wait, wait, wait

Methods inherited from interface CAstEntity

getNamePosition, getOriginal, getPosition

Modifier and Type	Method	Description
CAstSourcePositionMap.Position	getNamePosition()	The source position of the token denoting this entity's name.
default CAstEntity	getOriginal()	Allow finding original entity after rewrites
CAstSourcePositionMap.Position	getPosition(int arg)	The source position of argument 'arg' this entity, if any;

Constructor Details

AbstractFieldEntity

public AbstractFieldEntity(String name,
 Set<CAstQualifier> modifiers,
 boolean isStatic,
 CAstEntity declaringClass)

Method Details

toString

public String toString()

Overrides:

toString in class Object

getKind

public int getKind()

Description copied from interface: CAstEntity

What kind of entity is this? The answer should be one of the constants in this file. This has no meaning to the CAPA AST interfaces, but should be meaningful to a given producer and consumer of an entity.

getName

public String getName()

Description copied from interface: CAstEntity

Some programming language constructs have names. This should be it, if appropriate, and null otherwise.

getType

public CAstType getType()

Description copied from interface: CAstEntity

The CAst type of this entity.

getQualifiers

public Collection<CAstQualifier> getQualifiers()

Description copied from interface: CAstEntity

Returns an Iterator over the qualifiers of the given entity, if it has any, e.g., "final", "private".

getAST

public CAstNode getAST()

Description copied from interface: CAstEntity

The CAPA AST of this entity.

getControlFlow

public CAstControlFlowMap getControlFlow()

Description copied from interface: CAstEntity

The control flow map for the CAPA AST of this entity.

getSourceMap

public CAstSourcePositionMap getSourceMap()

Description copied from interface: CAstEntity

The map of CAstNodes to source positions for the CAPA AST of this entity.

getNodeTypeMap

public CAstNodeTypeMap getNodeTypeMap()

Description copied from interface: CAstEntity

The map from CAstNodes to types. Valid for nodes that have an explicitly declared type (e.g. local vars).

getArgumentNames

public String[] getArgumentNames()

Description copied from interface: CAstEntity

Some programming language constructs have named arguments. This should be their names, if appropriate. Otherwise, please return an array of size 0, since null can be a pain.

getArgumentDefaults

public CAstNode[] getArgumentDefaults()

Description copied from interface: CAstEntity

Some programming language constructs allow arguments to have default values. This should be those defaults, one per named argument above. Otherwise, please return an array of size 0, since null can be a pain.

getArgumentCount

public int getArgumentCount()

Description copied from interface: CAstEntity

Some programming language constructs have a specific number of arguments. This should be that number, if appropriate, and 0 otherwise.