com.ibm.wala.cast.ir.translator
Class AbstractGlobalEntity

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

All Implemented Interfaces:

CAstEntity

public class AbstractGlobalEntity
extends AbstractEntity

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

AbstractGlobalEntity(java.lang.String name, CAstType type, java.util.Set<CAstQualifier> modifiers)

Method Summary

int	getArgumentCount() Some programming language constructs have a specific number of arguments.
CAstNode[]	getArgumentDefaults() Some programming language constructs allow arguments to have default values.
java.lang.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.
java.lang.String	getName() Some programming language constructs have names.
CAstNodeTypeMap	getNodeTypeMap() The map from CAstNodes to types.
java.util.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.
java.lang.String	toString()

Methods inherited from class com.ibm.wala.cast.ir.translator.AbstractEntity

addScopedEntity, getAllScopedEntities, getPosition, getScopedEntities, getSignature, setPosition

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGlobalEntity

public AbstractGlobalEntity(java.lang.String name,
                            CAstType type,
                            java.util.Set<CAstQualifier> modifiers)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.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 java.lang.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 java.util.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 java.lang.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.