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 List	EMPTY_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
void	addModifier(int modifier)
int	compareTo(Object o)
AbstractClass	getContainingAbstractClass()
XClass	getContainingClass()
XPackage	getContainingPackage()
XDoc	getDoc() Get the doc.
String	getModifiers() Get modifiers string.
int	getModifierSpecifier() Get the modifier specifier integer.
protected XTagFactory	getTagFactory()
XJavaDoc	getXJavaDoc()
boolean	isAbstract()
boolean	isFinal()
boolean	isPackagePrivate()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
void	reset()
void	setJavaDoc()
void	setToken(Token token) Sets the Token where we start.
void	updateDoc() 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