Interface JavaProcedureEntity

All Superinterfaces:

CAstEntity

All Known Implementing Classes:

JDTJava2CAstTranslator.ProcedureEntity

public interface JavaProcedureEntity
extends 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.

Method Summary

Modifier and Type	Method	Description
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.

Methods inherited from interface CAstEntity

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

Modifier and Type	Method	Description
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
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()	The source position of this entity.
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".
Iterator<CAstEntity>	getScopedEntities(CAstNode construct)	Some programming language constructs have a lexical structure.
CAstSourcePositionMap	getSourceMap()	The map of CAstNodes to source positions for the CAPA AST of this entity.
CAstType	getType()	The CAst type of this entity.

Method Details

getSignature

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