Package org.aspectj.asm

Interface IProgramElement

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProgramElement

public interface IProgramElement
extends Serializable

Represents program elements in the AspectJ containment hierarchy.

Author:

Mik Kersten

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IProgramElement.Accessibility	Uses "typesafe enum" pattern.
static class	IProgramElement.ExtraInformation
static class	IProgramElement.Kind	Uses "typesafe enum" pattern.
static class	IProgramElement.Modifiers	Uses "typesafe enum" pattern.

Method Summary

Modifier and Type	Method	Description
void	addChild(IProgramElement child)
void	addFullyQualifiedName(String fqname)
IProgramElement.Accessibility	getAccessibility()
String	getAnnotationType()
String	getBytecodeName()
String	getBytecodeSignature()
List<IProgramElement>	getChildren()
String	getCorrespondingType()	This correponds to both method return types and field types.
String	getCorrespondingType(boolean getFullyQualifiedType)
String	getCorrespondingTypeSignature()
Map<String,List<String>>	getDeclareParentsMap()
String	getDeclaringType()
String	getDetails()
IProgramElement.ExtraInformation	getExtraInfo()
String	getFormalComment()
String	getFullyQualifiedName()
String	getHandleIdentifier()	The format of the string handle is not specified, but is stable across compilation sessions.
String	getHandleIdentifier(boolean create)
IProgramElement.Kind	getKind()
IMessage	getMessage()
AsmManager	getModel()
List<IProgramElement.Modifiers>	getModifiers()
String	getName()
String	getPackageName()
List<String>	getParameterNames()
List<char[]>	getParameterSignatures()
List<String>	getParameterSignaturesSourceRefs()
List<char[]>	getParameterTypes()
IProgramElement	getParent()
List<String>	getParentTypes()
int	getRawModifiers()
String[]	getRemovedAnnotationTypes()
ISourceLocation	getSourceLocation()
String	getSourceSignature()
boolean	isAnnotationRemover()
boolean	isAnnotationStyleDeclaration()
boolean	isImplementor()
boolean	isOverrider()
boolean	isRunnable()
boolean	removeChild(IProgramElement child)
void	setAnnotationRemover(boolean isRemover)
void	setAnnotationStyleDeclaration(boolean b)
void	setAnnotationType(String fullyQualifiedannotationType)
void	setBytecodeName(String bytecodeName)
void	setBytecodeSignature(String bytecodeSignature)
void	setChildren(List<IProgramElement> children)
void	setCorrespondingType(String returnType)
void	setDeclareParentsMap(Map<String,List<String>> newmap)
void	setDetails(String details)
void	setExtraInfo(IProgramElement.ExtraInformation info)
void	setFormalComment(String comment)
void	setHandleIdentifier(String handle)
void	setImplementor(boolean value)
void	setKind(IProgramElement.Kind kind)
void	setMessage(IMessage message)
void	setModifiers(int i)
void	setName(String name)
void	setOverrider(boolean value)
void	setParameterNames(List<String> list)
void	setParameterSignatures(List<char[]> list, List<String> paramSourceRefs)
void	setParent(IProgramElement parent)
void	setParentTypes(List<String> parentTypes)
void	setRunnable(boolean value)
void	setSourceLocation(ISourceLocation sourceLocation)
void	setSourceSignature(String string)
String	toLabelString()	Includes name, parameter types (if any) and details (if any).
String	toLabelString(boolean getFullyQualifiedArgTypes)
String	toLinkLabelString()	Includes information about the origin of the node.
String	toLinkLabelString(boolean getFullyQualifiedArgTypes)
String	toLongString()
String	toSignatureString()
String	toSignatureString(boolean getFullyQualifiedArgTypes)
String	toString()
IProgramElement	walk(HierarchyWalker walker)

Method Details

getChildren

List<IProgramElement> getChildren()

setChildren

void setChildren(List<IProgramElement> children)

addChild

void addChild(IProgramElement child)

removeChild

boolean removeChild(IProgramElement child)

setExtraInfo

void setExtraInfo(IProgramElement.ExtraInformation info)

getExtraInfo

IProgramElement.ExtraInformation getExtraInfo()

getParent

IProgramElement getParent()

setParent

void setParent(IProgramElement parent)

setParentTypes

void setParentTypes(List<String> parentTypes)

getParentTypes

List<String> getParentTypes()

getName

String getName()

setName

void setName(String name)

getDetails

String getDetails()

setDetails

void setDetails(String details)

getKind

IProgramElement.Kind getKind()

setKind

void setKind(IProgramElement.Kind kind)

getModifiers

List<IProgramElement.Modifiers> getModifiers()

setModifiers

void setModifiers(int i)

getAccessibility

IProgramElement.Accessibility getAccessibility()

getDeclaringType

String getDeclaringType()

getPackageName

String getPackageName()

setCorrespondingType

void setCorrespondingType(String returnType)

Parameters:

returnType - return types or field types

getCorrespondingType

String getCorrespondingType()

This correponds to both method return types and field types.

getCorrespondingType

String getCorrespondingType(boolean getFullyQualifiedType)

toSignatureString

String toSignatureString()

toSignatureString

String toSignatureString(boolean getFullyQualifiedArgTypes)

setRunnable

void setRunnable(boolean value)

isRunnable

boolean isRunnable()

isImplementor

boolean isImplementor()

setImplementor

void setImplementor(boolean value)

isOverrider

boolean isOverrider()

setOverrider

void setOverrider(boolean value)

getMessage

IMessage getMessage()

setMessage

void setMessage(IMessage message)

getSourceLocation

ISourceLocation getSourceLocation()

setSourceLocation

void setSourceLocation(ISourceLocation sourceLocation)

toString

String toString()

Overrides:

toString in class Object

getFormalComment

String getFormalComment()

Returns:

the javadoc comment for this program element, null if not available

setFormalComment

void setFormalComment(String comment)

toLinkLabelString

String toLinkLabelString()

Includes information about the origin of the node.

toLinkLabelString

String toLinkLabelString(boolean getFullyQualifiedArgTypes)

toLabelString

String toLabelString()

Includes name, parameter types (if any) and details (if any).

toLabelString

String toLabelString(boolean getFullyQualifiedArgTypes)

getParameterNames

List<String> getParameterNames()

setParameterNames

void setParameterNames(List<String> list)

getParameterSignatures

List<char[]> getParameterSignatures()

getParameterSignaturesSourceRefs

List<String> getParameterSignaturesSourceRefs()

setParameterSignatures

void setParameterSignatures(List<char[]> list,
 List<String> paramSourceRefs)

getParameterTypes

List<char[]> getParameterTypes()

getHandleIdentifier

String getHandleIdentifier()

The format of the string handle is not specified, but is stable across compilation sessions.

Returns:

a string representation of this element

getHandleIdentifier

String getHandleIdentifier(boolean create)

setHandleIdentifier

void setHandleIdentifier(String handle)

toLongString

String toLongString()

Returns:

a string representation of this node and all of its children (recursive)

getBytecodeName

String getBytecodeName()

getBytecodeSignature

String getBytecodeSignature()

setBytecodeName

void setBytecodeName(String bytecodeName)

setBytecodeSignature

void setBytecodeSignature(String bytecodeSignature)

getSourceSignature

String getSourceSignature()

Returns:

the full signature of this element, as it appears in the source

setSourceSignature

void setSourceSignature(String string)

walk

IProgramElement walk(HierarchyWalker walker)

getModel

AsmManager getModel()

getRawModifiers

int getRawModifiers()

setAnnotationStyleDeclaration

void setAnnotationStyleDeclaration(boolean b)

isAnnotationStyleDeclaration

boolean isAnnotationStyleDeclaration()

setAnnotationType

void setAnnotationType(String fullyQualifiedannotationType)

Parameters:

fullyQualifiedannotationType - the annotation type, eg. p.q.r.Foo

getAnnotationType

String getAnnotationType()

Returns:

the fully qualified annotation type, eg. p.q.r.Foo

getRemovedAnnotationTypes

String[] getRemovedAnnotationTypes()

getDeclareParentsMap

Map<String,List<String>> getDeclareParentsMap()

setDeclareParentsMap

void setDeclareParentsMap(Map<String,List<String>> newmap)

addFullyQualifiedName

void addFullyQualifiedName(String fqname)

getFullyQualifiedName

String getFullyQualifiedName()

setAnnotationRemover

void setAnnotationRemover(boolean isRemover)

isAnnotationRemover

boolean isAnnotationRemover()

getCorrespondingTypeSignature

String getCorrespondingTypeSignature()

Returns:

the return type of a method or type of a field in signature form (e.g. Ljava/lang/String;)