xjavadoc

Class AbstractProgramElement

public abstract class AbstractProgramElement extends Object implements XProgramElement

Describe what this class does

Author: Ara Abrahamian Aslak Hellesxy

UNKNOWN: 7. mars 2003

Field Summary
static ListEMPTY_LIST
AbstractClass_containingClass
XDoc_doc
Token_javadocToken
int_modifiers
String_modifierString
XTagFactory_tagFactory
Token_token
XJavaDoc_xJavaDoc
Constructor Summary
protected AbstractProgramElement(AbstractClass containingClass, XTagFactory tagFactory)
protected AbstractProgramElement(XJavaDoc xJavaDoc, XTagFactory tagFactory)
Method Summary
voidaddModifier(int modifier)
intcompareTo(Object o)
AbstractClassgetContainingAbstractClass()
XClassgetContainingClass()
XPackagegetContainingPackage()
XDocgetDoc()
Get the doc.
StringgetModifiers()
Get modifiers string.
intgetModifierSpecifier()
Get the modifier specifier integer.
protected XTagFactorygetTagFactory()
XJavaDocgetXJavaDoc()
booleanisAbstract()
booleanisFinal()
booleanisPackagePrivate()
booleanisPrivate()
booleanisProtected()
booleanisPublic()
booleanisStatic()
voidreset()
voidsetJavaDoc()
voidsetToken(Token token)
Sets the Token where we start.
voidupdateDoc()
update javadoc

Field Detail

EMPTY_LIST

static final List EMPTY_LIST

_containingClass

private AbstractClass _containingClass

_doc

private XDoc _doc

_javadocToken

private Token _javadocToken

_modifiers

private int _modifiers

_modifierString

private String _modifierString

_tagFactory

private final XTagFactory _tagFactory

_token

private Token _token

_xJavaDoc

private XJavaDoc _xJavaDoc

Constructor Detail

AbstractProgramElement

protected AbstractProgramElement(AbstractClass containingClass, XTagFactory tagFactory)

AbstractProgramElement

protected AbstractProgramElement(XJavaDoc xJavaDoc, XTagFactory tagFactory)

Method Detail

addModifier

public final void addModifier(int modifier)

compareTo

public int compareTo(Object o)

getContainingAbstractClass

public final AbstractClass getContainingAbstractClass()

getContainingClass

public final XClass getContainingClass()

getContainingPackage

public XPackage getContainingPackage()

getDoc

public final XDoc getDoc()
Get the doc. If this is a binary, primitive or unknown, null is returned.

Returns: the class level doc

getModifiers

public final String getModifiers()
Get modifiers string.

Returns:

getModifierSpecifier

public final int getModifierSpecifier()
Get the modifier specifier integer.

Returns:

getTagFactory

protected XTagFactory getTagFactory()

getXJavaDoc

public XJavaDoc getXJavaDoc()

isAbstract

public final boolean isAbstract()

isFinal

public final boolean isFinal()

isPackagePrivate

public final boolean isPackagePrivate()

isPrivate

public final boolean isPrivate()

isProtected

public final boolean isProtected()

isPublic

public final boolean isPublic()

isStatic

public final boolean isStatic()

reset

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