org.aspectj.asm
Interface IProgramElement

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ProgramElement

public interface IProgramElement
extends java.io.Serializable

Represents program elements in the AspectJ containment hierarchy.

Nested Class Summary

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

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

Method Detail

getChildren

java.util.List<IProgramElement> getChildren()

setChildren

void setChildren(java.util.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(java.util.List<java.lang.String> parentTypes)

getParentTypes

java.util.List<java.lang.String> getParentTypes()

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getDetails

java.lang.String getDetails()

setDetails

void setDetails(java.lang.String details)

getKind

IProgramElement.Kind getKind()

setKind

void setKind(IProgramElement.Kind kind)

getModifiers

java.util.List<IProgramElement.Modifiers> getModifiers()

setModifiers

void setModifiers(int i)

getAccessibility

IProgramElement.Accessibility getAccessibility()

getDeclaringType

java.lang.String getDeclaringType()

getPackageName

java.lang.String getPackageName()

setCorrespondingType

void setCorrespondingType(java.lang.String returnType)

Parameters:

method - return types or field types

getCorrespondingType

java.lang.String getCorrespondingType()

This correponds to both method return types and field types.

getCorrespondingType

java.lang.String getCorrespondingType(boolean getFullyQualifiedType)

toSignatureString

java.lang.String toSignatureString()

toSignatureString

java.lang.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

java.lang.String toString()

Overrides:

toString in class java.lang.Object

getFormalComment

java.lang.String getFormalComment()

Returns:

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

setFormalComment

void setFormalComment(java.lang.String comment)

toLinkLabelString

java.lang.String toLinkLabelString()

Includes information about the origin of the node.

toLinkLabelString

java.lang.String toLinkLabelString(boolean getFullyQualifiedArgTypes)

toLabelString

java.lang.String toLabelString()

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

toLabelString

java.lang.String toLabelString(boolean getFullyQualifiedArgTypes)

getParameterNames

java.util.List<java.lang.String> getParameterNames()

setParameterNames

void setParameterNames(java.util.List<java.lang.String> list)

getParameterSignatures

java.util.List<char[]> getParameterSignatures()

getParameterSignaturesSourceRefs

java.util.List<java.lang.String> getParameterSignaturesSourceRefs()

setParameterSignatures

void setParameterSignatures(java.util.List<char[]> list,
                            java.util.List<java.lang.String> paramSourceRefs)

getParameterTypes

java.util.List<char[]> getParameterTypes()

getHandleIdentifier

java.lang.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

java.lang.String getHandleIdentifier(boolean create)

setHandleIdentifier

void setHandleIdentifier(java.lang.String handle)

toLongString

java.lang.String toLongString()

Returns:

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

getBytecodeName

java.lang.String getBytecodeName()

getBytecodeSignature

java.lang.String getBytecodeSignature()

setBytecodeName

void setBytecodeName(java.lang.String bytecodeName)

setBytecodeSignature

void setBytecodeSignature(java.lang.String bytecodeSignature)

getSourceSignature

java.lang.String getSourceSignature()

Returns:

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

setSourceSignature

void setSourceSignature(java.lang.String string)

walk

IProgramElement walk(HierarchyWalker walker)

getModel

AsmManager getModel()

getRawModifiers

int getRawModifiers()

setAnnotationStyleDeclaration

void setAnnotationStyleDeclaration(boolean b)

isAnnotationStyleDeclaration

boolean isAnnotationStyleDeclaration()

setAnnotationType

void setAnnotationType(java.lang.String fullyQualifiedannotationType)

Parameters:

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

getAnnotationType

java.lang.String getAnnotationType()

Returns:

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

getRemovedAnnotationTypes

java.lang.String[] getRemovedAnnotationTypes()

getDeclareParentsMap

java.util.Map<java.lang.String,java.util.List<java.lang.String>> getDeclareParentsMap()

setDeclareParentsMap

void setDeclareParentsMap(java.util.Map<java.lang.String,java.util.List<java.lang.String>> newmap)

addFullyQualifiedName

void addFullyQualifiedName(java.lang.String fqname)

getFullyQualifiedName

java.lang.String getFullyQualifiedName()

setAnnotationRemover

void setAnnotationRemover(boolean isRemover)

isAnnotationRemover

boolean isAnnotationRemover()

getCorrespondingTypeSignature

java.lang.String getCorrespondingTypeSignature()

Returns:

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