Package org.aspectj.asm.internal

Class ProgramElement

java.lang.Object

org.aspectj.asm.internal.ProgramElement

All Implemented Interfaces:

Serializable, IProgramElement

public class ProgramElement
extends Object
implements IProgramElement

Author:

Mik Kersten, Andy Clement

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.aspectj.asm.IProgramElement

IProgramElement.Accessibility, IProgramElement.ExtraInformation, IProgramElement.Kind, IProgramElement.Modifiers

Field Summary

Fields

Modifier and Type	Field	Description
AsmManager	asm
protected List<IProgramElement>	children
Map<String,Object>	kvpairs
int	modifiers
protected String	name
protected IProgramElement	parent
static boolean	shortITDNames
protected ISourceLocation	sourceLocation

Constructor Summary

Constructors

Constructor	Description
ProgramElement()	Used during deserialization
ProgramElement(AsmManager asm, String name, IProgramElement.Kind kind, List<IProgramElement> children)	Use to create program element nodes that do not correspond to source locations
ProgramElement(AsmManager asm, String name, IProgramElement.Kind kind, ISourceLocation sourceLocation, int modifiers, String comment, List<IProgramElement> children)

Method Summary

Modifier and Type

Method

Description

void

addChild(int position, IProgramElement child)

void

addChild(IProgramElement child)

void

addFullyQualifiedName(String fqname)

void

addModifiers(IProgramElement.Modifiers newModifier)

Convenience mechanism for setting new modifiers which do not require knowledge of the private internal representation

static IProgramElement.Accessibility

genAccessibility(int modifiers)

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

isCode()

boolean

isImplementor()

boolean

isMemberKind()

boolean

isOverrider()

boolean

isRunnable()

static String

nameToSignature(String name)

boolean

removeChild(IProgramElement child)

void

setAnnotationRemover(boolean isRemover)

void

setAnnotationStyleDeclaration(boolean b)

void

setAnnotationType(String fullyQualifiedAnnotationType)

void

setBytecodeName(String s)

void

setBytecodeSignature(String s)

void

setChildren(List<IProgramElement> children)

void

setCorrespondingType(String s)

void

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

void

setDeclaringType(String t)

void

setDetails(String string)

void

setExtraInfo(IProgramElement.ExtraInformation info)

void

setFormalComment(String txt)

void

setHandleIdentifier(String handle)

void

setImplementor(boolean value)

void

setKind(IProgramElement.Kind kind)

void

setMessage(IMessage message)

void

setModifiers(int i)

void

setName(String string)

void

setOverrider(boolean value)

void

setParameterNames(List<String> list)

void

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

Set the parameter signatures for this method/constructor.

void

setParent(IProgramElement parent)

void

setParentTypes(List<String> ps)

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()

TODO: move the "parent !

String

toLinkLabelString(boolean getFullyQualifiedArgTypes)

String

toLongString()

String

toSignatureString()

String

toSignatureString(boolean getFullyQualifiedArgTypes)

String

toString()

static String

trim(String fqname)

Trim down fully qualified types to their short form (e.g., a.b.c.D<e.f.G> becomes D<G>)

IProgramElement

walk(HierarchyWalker walker)

Methods inherited from class java.lang.Object

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

Field Details

asm

public transient AsmManager asm

shortITDNames

public static boolean shortITDNames

name

protected String name

parent

protected IProgramElement parent

children

protected List<IProgramElement> children

kvpairs

public Map<String,Object> kvpairs

sourceLocation

protected ISourceLocation sourceLocation

modifiers

public int modifiers

Constructor Details

ProgramElement

public ProgramElement()

Used during deserialization

ProgramElement

public ProgramElement(AsmManager asm,
 String name,
 IProgramElement.Kind kind,
 List<IProgramElement> children)

Use to create program element nodes that do not correspond to source locations

ProgramElement

public ProgramElement(AsmManager asm,
 String name,
 IProgramElement.Kind kind,
 ISourceLocation sourceLocation,
 int modifiers,
 String comment,
 List<IProgramElement> children)

Method Details

getModel

public AsmManager getModel()

Specified by:

getModel in interface IProgramElement

getRawModifiers

public int getRawModifiers()

Specified by:

getRawModifiers in interface IProgramElement

getModifiers

public List<IProgramElement.Modifiers> getModifiers()

Specified by:

getModifiers in interface IProgramElement

getAccessibility

public IProgramElement.Accessibility getAccessibility()

Specified by:

getAccessibility in interface IProgramElement

setDeclaringType

public void setDeclaringType(String t)

getDeclaringType

public String getDeclaringType()

Specified by:

getDeclaringType in interface IProgramElement

getPackageName

public String getPackageName()

Specified by:

getPackageName in interface IProgramElement

getKind

public IProgramElement.Kind getKind()

Specified by:

getKind in interface IProgramElement

isCode

public boolean isCode()

getSourceLocation

public ISourceLocation getSourceLocation()

Specified by:

getSourceLocation in interface IProgramElement

setSourceLocation

public void setSourceLocation(ISourceLocation sourceLocation)

Specified by:

setSourceLocation in interface IProgramElement

getMessage

public IMessage getMessage()

Specified by:

getMessage in interface IProgramElement

setMessage

public void setMessage(IMessage message)

Specified by:

setMessage in interface IProgramElement

getParent

public IProgramElement getParent()

Specified by:

getParent in interface IProgramElement

setParent

public void setParent(IProgramElement parent)

Specified by:

setParent in interface IProgramElement

isMemberKind

public boolean isMemberKind()

setRunnable

public void setRunnable(boolean value)

Specified by:

setRunnable in interface IProgramElement

isRunnable

public boolean isRunnable()

Specified by:

isRunnable in interface IProgramElement

isImplementor

public boolean isImplementor()

Specified by:

isImplementor in interface IProgramElement

setImplementor

public void setImplementor(boolean value)

Specified by:

setImplementor in interface IProgramElement

isOverrider

public boolean isOverrider()

Specified by:

isOverrider in interface IProgramElement

setOverrider

public void setOverrider(boolean value)

Specified by:

setOverrider in interface IProgramElement

getFormalComment

public String getFormalComment()

Specified by:

getFormalComment in interface IProgramElement

Returns:

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

toString

public String toString()

Specified by:

toString in interface IProgramElement

Overrides:

toString in class Object

genAccessibility

public static IProgramElement.Accessibility genAccessibility(int modifiers)

getBytecodeName

public String getBytecodeName()

Specified by:

getBytecodeName in interface IProgramElement

setBytecodeName

public void setBytecodeName(String s)

Specified by:

setBytecodeName in interface IProgramElement

setBytecodeSignature

public void setBytecodeSignature(String s)

Specified by:

setBytecodeSignature in interface IProgramElement

getBytecodeSignature

public String getBytecodeSignature()

Specified by:

getBytecodeSignature in interface IProgramElement

getSourceSignature

public String getSourceSignature()

Specified by:

getSourceSignature in interface IProgramElement

Returns:

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

setSourceSignature

public void setSourceSignature(String string)

Specified by:

setSourceSignature in interface IProgramElement

setKind

public void setKind(IProgramElement.Kind kind)

Specified by:

setKind in interface IProgramElement

setCorrespondingType

public void setCorrespondingType(String s)

Specified by:

setCorrespondingType in interface IProgramElement

Parameters:

s - return types or field types

setParentTypes

public void setParentTypes(List<String> ps)

Specified by:

setParentTypes in interface IProgramElement

getParentTypes

public List<String> getParentTypes()

Specified by:

getParentTypes in interface IProgramElement

setAnnotationType

public void setAnnotationType(String fullyQualifiedAnnotationType)

Specified by:

setAnnotationType in interface IProgramElement

Parameters:

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

setAnnotationRemover

public void setAnnotationRemover(boolean isRemover)

Specified by:

setAnnotationRemover in interface IProgramElement

getAnnotationType

public String getAnnotationType()

Specified by:

getAnnotationType in interface IProgramElement

Returns:

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

isAnnotationRemover

public boolean isAnnotationRemover()

Specified by:

isAnnotationRemover in interface IProgramElement

getRemovedAnnotationTypes

public String[] getRemovedAnnotationTypes()

Specified by:

getRemovedAnnotationTypes in interface IProgramElement

getCorrespondingType

public String getCorrespondingType()

Description copied from interface: IProgramElement

This correponds to both method return types and field types.

Specified by:

getCorrespondingType in interface IProgramElement

getCorrespondingTypeSignature

public String getCorrespondingTypeSignature()

Specified by:

getCorrespondingTypeSignature in interface IProgramElement

Returns:

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

nameToSignature

public static String nameToSignature(String name)

getCorrespondingType

public String getCorrespondingType(boolean getFullyQualifiedType)

Specified by:

getCorrespondingType in interface IProgramElement

trim

public static String trim(String fqname)

Trim down fully qualified types to their short form (e.g., a.b.c.D<e.f.G> becomes D<G>)

getName

public String getName()

Specified by:

getName in interface IProgramElement

getChildren

public List<IProgramElement> getChildren()

Specified by:

getChildren in interface IProgramElement

setChildren

public void setChildren(List<IProgramElement> children)

Specified by:

setChildren in interface IProgramElement

addChild

public void addChild(IProgramElement child)

Specified by:

addChild in interface IProgramElement

addChild

public void addChild(int position,
 IProgramElement child)

removeChild

public boolean removeChild(IProgramElement child)

Specified by:

removeChild in interface IProgramElement

setName

public void setName(String string)

Specified by:

setName in interface IProgramElement

walk

public IProgramElement walk(HierarchyWalker walker)

Specified by:

walk in interface IProgramElement

toLongString

public String toLongString()

Specified by:

toLongString in interface IProgramElement

Returns:

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

setModifiers

public void setModifiers(int i)

Specified by:

setModifiers in interface IProgramElement

addModifiers

public void addModifiers(IProgramElement.Modifiers newModifier)

Convenience mechanism for setting new modifiers which do not require knowledge of the private internal representation

Parameters:

newModifier -

toSignatureString

public String toSignatureString()

Specified by:

toSignatureString in interface IProgramElement

toSignatureString

public String toSignatureString(boolean getFullyQualifiedArgTypes)

Specified by:

toSignatureString in interface IProgramElement

toLinkLabelString

public String toLinkLabelString()

TODO: move the "parent != null"→injar heuristic to more explicit

Specified by:

toLinkLabelString in interface IProgramElement

toLinkLabelString

public String toLinkLabelString(boolean getFullyQualifiedArgTypes)

Specified by:

toLinkLabelString in interface IProgramElement

toLabelString

public String toLabelString()

Description copied from interface: IProgramElement

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

Specified by:

toLabelString in interface IProgramElement

toLabelString

public String toLabelString(boolean getFullyQualifiedArgTypes)

Specified by:

toLabelString in interface IProgramElement

getHandleIdentifier

public String getHandleIdentifier()

Description copied from interface: IProgramElement

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

Specified by:

getHandleIdentifier in interface IProgramElement

Returns:

a string representation of this element

getHandleIdentifier

public String getHandleIdentifier(boolean create)

Specified by:

getHandleIdentifier in interface IProgramElement

setHandleIdentifier

public void setHandleIdentifier(String handle)

Specified by:

setHandleIdentifier in interface IProgramElement

getParameterNames

public List<String> getParameterNames()

Specified by:

getParameterNames in interface IProgramElement

setParameterNames

public void setParameterNames(List<String> list)

Specified by:

setParameterNames in interface IProgramElement

getParameterTypes

public List<char[]> getParameterTypes()

Specified by:

getParameterTypes in interface IProgramElement

getParameterSignatures

public List<char[]> getParameterSignatures()

Specified by:

getParameterSignatures in interface IProgramElement

getParameterSignaturesSourceRefs

public List<String> getParameterSignaturesSourceRefs()

Specified by:

getParameterSignaturesSourceRefs in interface IProgramElement

setParameterSignatures

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

Set the parameter signatures for this method/constructor. The bit flags tell us if any were not singletypereferences in the the source. A singletypereference would be 'String' - whilst a qualifiedtypereference would be 'java.lang.String' - this has an effect on the handles.

Specified by:

setParameterSignatures in interface IProgramElement

getDetails

public String getDetails()

Specified by:

getDetails in interface IProgramElement

setDetails

public void setDetails(String string)

Specified by:

setDetails in interface IProgramElement

setFormalComment

public void setFormalComment(String txt)

Specified by:

setFormalComment in interface IProgramElement

setExtraInfo

public void setExtraInfo(IProgramElement.ExtraInformation info)

Specified by:

setExtraInfo in interface IProgramElement

getExtraInfo

public IProgramElement.ExtraInformation getExtraInfo()

Specified by:

getExtraInfo in interface IProgramElement

isAnnotationStyleDeclaration

public boolean isAnnotationStyleDeclaration()

Specified by:

isAnnotationStyleDeclaration in interface IProgramElement

setAnnotationStyleDeclaration

public void setAnnotationStyleDeclaration(boolean b)

Specified by:

setAnnotationStyleDeclaration in interface IProgramElement

getDeclareParentsMap

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

Specified by:

getDeclareParentsMap in interface IProgramElement

setDeclareParentsMap

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

Specified by:

setDeclareParentsMap in interface IProgramElement

addFullyQualifiedName

public void addFullyQualifiedName(String fqname)

Specified by:

addFullyQualifiedName in interface IProgramElement

getFullyQualifiedName

public String getFullyQualifiedName()

Specified by:

getFullyQualifiedName in interface IProgramElement