xjavadoc

Class AbstractProgramElement

Implemented Interfaces:
Comparable, Named, XProgramElement
Known Direct Subclasses:
AbstractClass, MemberImpl

public abstract class AbstractProgramElement
extends java.lang.Object
implements XProgramElement

Describe what this class does
Authors:
Ara Abrahamian
Aslak Helles?y

Field Summary

(package private) static List
EMPTY_LIST
private AbstractClass
_containingClass
private XDoc
_doc
private Token
_javadocToken
private String
_modifierString
private int
_modifiers
private XTagFactory
_tagFactory
private Token
_token
private XJavaDoc
_xJavaDoc

Constructor Summary

AbstractProgramElement(AbstractClass containingClass, XTagFactory tagFactory)
AbstractProgramElement(XJavaDoc xJavaDoc, XTagFactory tagFactory)

Method Summary

void
addModifier(int modifier)
int
compareTo(Object o)
AbstractClass
getContainingAbstractClass()
XClass
getContainingClass()
XPackage
getContainingPackage()
XDoc
getDoc()
Get the doc.
int
getModifierSpecifier()
Get the modifier specifier integer.
String
getModifiers()
Get modifiers string.
protected XTagFactory
getTagFactory()
XJavaDoc
getXJavaDoc()
boolean
isAbstract()
boolean
isFinal()
boolean
isPackagePrivate()
boolean
isPrivate()
boolean
isProtected()
boolean
isPublic()
boolean
isStatic()
(package private) void
reset()
private void
setJavaDoc()
void
setToken(Token token)
Sets the Token where we start.
void
updateDoc()
update javadoc

Field Details

EMPTY_LIST

(package private) static final List EMPTY_LIST

_containingClass

private AbstractClass _containingClass

_doc

private XDoc _doc

_javadocToken

private Token _javadocToken

_modifierString

private String _modifierString

_modifiers

private int _modifiers

_tagFactory

private final XTagFactory _tagFactory

_token

private Token _token

_xJavaDoc

private XJavaDoc _xJavaDoc

Constructor Details

AbstractProgramElement

protected AbstractProgramElement(AbstractClass containingClass,
                                 XTagFactory tagFactory)

AbstractProgramElement

protected AbstractProgramElement(XJavaDoc xJavaDoc,
                                 XTagFactory tagFactory)

Method Details

addModifier

public final void addModifier(int modifier)

compareTo

public int compareTo(Object o)

getContainingAbstractClass

public final AbstractClass getContainingAbstractClass()

getContainingClass

public final XClass getContainingClass()
Specified by:
getContainingClass in interface XProgramElement

getContainingPackage

public XPackage getContainingPackage()
Specified by:
getContainingPackage in interface XProgramElement

getDoc

public final XDoc getDoc()
Get the doc. If this is a binary, primitive or unknown, null is returned.
Specified by:
getDoc in interface XProgramElement
Returns:
the class level doc

getModifierSpecifier

public final int getModifierSpecifier()
Get the modifier specifier integer.
Specified by:
getModifierSpecifier in interface XProgramElement
Returns:

getModifiers

public final String getModifiers()
Get modifiers string.
Specified by:
getModifiers in interface XProgramElement
Returns:

getTagFactory

protected XTagFactory getTagFactory()

getXJavaDoc

public XJavaDoc getXJavaDoc()
Specified by:
getXJavaDoc in interface XProgramElement

isAbstract

public final boolean isAbstract()
Specified by:
isAbstract in interface XProgramElement

isFinal

public final boolean isFinal()
Specified by:
isFinal in interface XProgramElement

isPackagePrivate

public final boolean isPackagePrivate()
Specified by:
isPackagePrivate in interface XProgramElement

isPrivate

public final boolean isPrivate()
Specified by:
isPrivate in interface XProgramElement

isProtected

public final boolean isProtected()
Specified by:
isProtected in interface XProgramElement

isPublic

public final boolean isPublic()
Specified by:
isPublic in interface XProgramElement

isStatic

public final boolean isStatic()
Specified by:
isStatic in interface XProgramElement

reset

(package private)  void reset()

setJavaDoc

private final void setJavaDoc()

setToken

public final void setToken(Token token)
Sets the Token where we start. Useful for doc mutation.
Parameters:
token - The new Token value

updateDoc

public void updateDoc()
update javadoc
Specified by:
updateDoc in interface XProgramElement