AbstractEntity (API Reference for wala 1.3.9)

java.lang.Object
- com.ibm.wala.cast.ir.translator.AbstractEntity

All Implemented Interfaces:

CAstEntity

Direct Known Subclasses:

AbstractClassEntity, AbstractCodeEntity, AbstractGlobalEntity
```
public abstract class AbstractEntity
extends Object
implements CAstEntity
```

Field Summary
- Fields inherited from interface com.ibm.wala.cast.tree.CAstEntity
  FIELD_ENTITY, FILE_ENTITY, FUNCTION_ENTITY, GLOBAL_ENTITY, MACRO_ENTITY, RULE_ENTITY, SCRIPT_ENTITY, SUB_LANGUAGE_BASE, TYPE_ENTITY

Constructor Summary

Constructors
Constructor and Description

AbstractEntity()

Constructors
Constructor and Description
`AbstractEntity()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addScopedEntity(CAstNode construct, CAstEntity child)`
`Map<CAstNode,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 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.wala.cast.tree.CAstEntity
getArgumentCount, getArgumentDefaults, getArgumentNames, getAST, getControlFlow, getKind, getName, getNodeTypeMap, getQualifiers, getSourceMap, getType

- Constructor Detail
  - AbstractEntity
```
public AbstractEntity()
```
- Method Detail
  - getAllScopedEntities
```
public Map<CAstNode,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)
```

Class AbstractEntity

Field Summary

Fields inherited from interface com.ibm.wala.cast.tree.CAstEntity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.wala.cast.tree.CAstEntity

Constructor Detail

AbstractEntity

Method Detail

getAllScopedEntities

getSignature

getAnnotations

setPosition

getPosition

getScopedEntities

addScopedEntity