com.thoughtworks.qdox.model.impl

Class AbstractJavaEntity

java.lang.Object

com.thoughtworks.qdox.model.impl.AbstractJavaModel

com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity

com.thoughtworks.qdox.model.impl.AbstractJavaEntity

All Implemented Interfaces:

JavaModel, java.io.Serializable

Direct Known Subclasses:

AbstractInheritableJavaEntity, DefaultJavaField

public abstract class AbstractJavaEntity
extends AbstractBaseJavaEntity
implements JavaModel

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private JavaClass	declaringClass
private java.util.List<java.lang.String>	modifiers
private java.lang.String	name

Constructor Summary

Constructors

Constructor and Description
AbstractJavaEntity()

Method Summary

Modifier and Type	Method and Description
JavaClass	getDeclaringClass() Not every entity has a parentClass, but AnnotationFieldRef requires access to it.
java.util.List<java.lang.String>	getModifiers() Return list of modifiers as Strings.
java.lang.String	getName()
boolean	isAbstract() Equivalent of Modifier.isAbstract(int)
boolean	isFinal() Equivalent of Modifier.isFinal(int)
private boolean	isModifierPresent(java.lang.String modifier) Returns true if one of the modifiers matches the modifier
boolean	isNative() Equivalent of Modifier.isNative(int)
boolean	isPrivate() Equivalent of Modifier.isPrivate(int)
boolean	isProtected() Equivalent of Modifier.isProtected(int)
boolean	isPublic() Equivalent of Modifier.isPublic(int)
boolean	isStatic() Equivalent of Modifier.isStatic(int)
boolean	isStrictfp() Equivalent of Modifier.isStrict(int)
boolean	isSynchronized() Equivalent of Modifier.isSynchronized(int)
boolean	isTransient() Equivalent of Modifier.isTransient(int)
boolean	isVolatile() Equivalent of Modifier.isVolatile(int)
void	setDeclaringClass(JavaClass declaringClass)
void	setModifiers(java.util.List<java.lang.String> modifiers)
void	setName(java.lang.String name)

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractBaseJavaEntity

getAnnotations, getComment, getNamedParameter, getSource, getTagByName, getTags, getTagsByName, setAnnotations, setComment, setSource, setTags

Methods inherited from class com.thoughtworks.qdox.model.impl.AbstractJavaModel

getLineNumber, getModelWriter, setLineNumber, setModelWriterFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thoughtworks.qdox.model.JavaModel

getCodeBlock, getLineNumber

Field Detail

modifiers

private java.util.List<java.lang.String> modifiers

declaringClass

private JavaClass declaringClass

name

private java.lang.String name

Constructor Detail

AbstractJavaEntity

public AbstractJavaEntity()

Method Detail

getModifiers

public java.util.List<java.lang.String> getModifiers()

Return list of modifiers as Strings. (public, private, protected, final, abstract, static)

Returns:

a list of modifiers, never null

setModifiers

public void setModifiers(java.util.List<java.lang.String> modifiers)

isAbstract

public boolean isAbstract()

Equivalent of Modifier.isAbstract(int)

Returns:

true if entity is abstract, otherwise false

isPublic

public boolean isPublic()

Equivalent of Modifier.isPublic(int)

Returns:

true if entity is public, otherwise false

isPrivate

public boolean isPrivate()

Equivalent of Modifier.isPrivate(int)

Returns:

true if entity is private, otherwise false

isProtected

public boolean isProtected()

Equivalent of Modifier.isProtected(int)

Returns:

true if entity is protected, otherwise false

isStatic

public boolean isStatic()

Equivalent of Modifier.isStatic(int)

Returns:

true if entity is static, otherwise false

isFinal

public boolean isFinal()

Equivalent of Modifier.isFinal(int)

Returns:

true if entity is final, otherwise false

isSynchronized

public boolean isSynchronized()

Equivalent of Modifier.isSynchronized(int)

Returns:

true if entity is sunchronized, otherwise false

isTransient

public boolean isTransient()

Equivalent of Modifier.isTransient(int)

Returns:

true if entity is transient, otherwise false

isVolatile

public boolean isVolatile()

Equivalent of Modifier.isVolatile(int)

Returns:

true if entity is volatile, otherwise false

Since:

1.4

isNative

public boolean isNative()

Equivalent of Modifier.isNative(int)

Returns:

true if entity is native, otherwise false

Since:

1.4

isStrictfp

public boolean isStrictfp()

Equivalent of Modifier.isStrict(int)

Returns:

true if entity is strictfp, otherwise false

Since:

1.4

isModifierPresent

private boolean isModifierPresent(java.lang.String modifier)

Returns true if one of the modifiers matches the modifier

Parameters:

modifier - the modifier

Returns:

true if the modifier is present, otherwise false

setDeclaringClass

public void setDeclaringClass(JavaClass declaringClass)

getDeclaringClass

public JavaClass getDeclaringClass()

Not every entity has a parentClass, but AnnotationFieldRef requires access to it. When used with JavaClass, don't confuse this with getSuperClass()

Overrides:

getDeclaringClass in class AbstractBaseJavaEntity

Returns:

the surrounding class

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)