|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--xjavadoc.AbstractProgramElement | +--xjavadoc.AbstractClass
Base implementation of XClass.
Constructor Summary | |
protected |
AbstractClass(AbstractClass containingClass)
|
protected |
AbstractClass(XJavaDoc xJavaDoc)
|
Method Summary | |
protected void |
addInnerClass(XClass clazz)
|
int |
compareTo(Object o)
|
boolean |
equals(Object obj)
|
List |
getAllSubclasses()
Returns the (known) subclasses, regardless of how deep in the class hierarchy. |
XConstructor |
getConstructor(String constructorNameWithSignature)
Gets the Constructor attribute of the AbstractClass object |
List |
getConstructors()
Gets the constructors. |
XPackage |
getContainingPackage()
Describe what the method does |
Collection |
getDeclaredInterfaces()
Returns the interfaces that are declared in the source code. |
List |
getDirectSubclasses()
Returns the (known) direct subclasses. |
List |
getExtendingInterfaces()
Return the (known) interfaces that extend this interface. |
XField |
getField(String fieldName)
Returns an XField with the given name. |
List |
getFields()
Describe what the method does |
List |
getFields(boolean superclasses)
|
List |
getFields(Predicate predicate,
boolean superclasses)
|
List |
getImplementingClasses()
Return the (known) classes that implement this interface. |
List |
getImportedClasses()
Describe what the method does |
List |
getImportedPackages()
Describe what the method does |
List |
getInnerClasses()
Describe what the method does |
List |
getInterfaces()
Returns all the implemented interfaces (if this is a class) or all the extended interfaces (if this is an interface) |
XMethod |
getMethod(String methodNameWithSignature)
|
XMethod |
getMethod(String methodNameWithSignature,
boolean superclasses)
Returns an XMethod with the given name and parameters. |
List |
getMethods()
Returns all the methods, not including superclasses |
List |
getMethods(boolean superclasses)
Returns all the methods. |
List |
getMethods(Predicate predicate,
boolean superclasses)
Returns all the methods that are accepted by the filter. |
List |
getMethodTags(String tagName,
boolean superclasses)
Returns a collection of tags from the methods in this class (or superclasses). |
String |
getName()
Get name |
String |
getQualifiedName()
Describe what the method does |
XClass |
getSuperclass()
Describe what the method does |
XProgramElement |
getSuperElement()
Describe what the method does |
String |
getType()
Gets the type, e.g. |
int |
hashCode()
|
protected boolean |
hasImportedClasses()
|
protected boolean |
hasImportedPackages()
|
protected boolean |
hasInnerClasses()
|
boolean |
isA(String full_qualified_type_name)
Returns true if we are subclass or implement the class/interface with the name classOrInterfaceName |
boolean |
isA(String full_qualified_type_name,
boolean superclasses)
Returns true if we are subclass or implement the class/interface with the name classOrInterfaceName |
boolean |
isAnonymous()
Returns true if this class is anonymous. |
boolean |
isImplementingInterface(String full_qualified_type_name)
Returns true if it implements full_qualified_type_name (or recursively superclasses implement). |
boolean |
isImplementingInterface(String full_qualified_type_name,
boolean superclasses)
Returns true if it implements full_qualified_type_name (or recursively superclasses implement, if superclasses==true). |
boolean |
isInner()
Returns true if this is an inner class. |
boolean |
isInterface()
Gets the Interface attribute of the SourceClass object |
boolean |
isSubclassOf(String full_qualified_type_name)
Returns true if the superclass (or recursively superclass of superclass) is full_qualified_type_name. |
boolean |
isSubclassOf(String full_qualified_type_name,
boolean superclasses)
Returns true if the superclass (or recursively superclass of superclass, if superclasses==true) is full_qualified_type_name. |
long |
lastModified()
|
XClass |
qualify(String unqualifiedClassName)
|
String |
save(File rootDir)
|
String |
toString()
|
void |
updateDoc()
update javadoc |
Methods inherited from class xjavadoc.AbstractProgramElement |
addModifier, getContainingAbstractClass, getContainingClass, getDoc, getModifiers, getModifierSpecifier, getXJavaDoc, isAbstract, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, setToken |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface xjavadoc.XClass |
isAbstract, isPrimitive, isWriteable, saveNeeded, setDirty |
Methods inherited from interface xjavadoc.XProgramElement |
getContainingClass, getDoc, getModifiers, getModifierSpecifier, getXJavaDoc, isFinal, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic |
Constructor Detail |
protected AbstractClass(AbstractClass containingClass)
protected AbstractClass(XJavaDoc xJavaDoc)
Method Detail |
public final boolean isInterface()
isInterface
in interface XClass
public final boolean isA(String full_qualified_type_name)
XClass
isA
in interface XClass
full_qualified_type_name
- The full qualified type name
public final boolean isA(String full_qualified_type_name, boolean superclasses)
XClass
isA
in interface XClass
full_qualified_type_name
- The full qualified type namesuperclasses
- whether the isA search should search the
whole hierarchy
public final XMethod getMethod(String methodNameWithSignature)
getMethod
in interface XClass
methodNameWithSignature
-
public final XMethod getMethod(String methodNameWithSignature, boolean superclasses)
XClass
getMethod
in interface XClass
methodNameWithSignature
- Describe what the parameter doessuperclasses
- Looks in superclasses too if true
public final XConstructor getConstructor(String constructorNameWithSignature)
getConstructor
in interface XClass
constructorNameWithSignature
- Describe what the parameter does
public final XField getField(String fieldName)
getField
in interface XClass
fieldName
- Describe what the parameter does
public final List getImportedClasses()
getImportedClasses
in interface XClass
public final List getImportedPackages()
getImportedPackages
in interface XClass
public final List getMethods()
XClass
getMethods
in interface XClass
public final List getMethods(Predicate predicate, boolean superclasses)
XClass
getMethods
in interface XClass
superclasses
- if true, include methods from superclasses too.predicate
-
public final List getFields(Predicate predicate, boolean superclasses)
public final List getMethods(boolean superclasses)
XClass
getMethods
in interface XClass
superclasses
- if true, include methods from superclasses and
interfaces too.
public final List getFields(boolean superclasses)
getFields
in interface XClass
public final List getFields()
getFields
in interface XClass
public final List getConstructors()
getConstructors
in interface XClass
public final boolean isSubclassOf(String full_qualified_type_name)
XClass
isSubclassOf
in interface XClass
full_qualified_type_name
- Describe what the parameter does
public final boolean isImplementingInterface(String full_qualified_type_name)
XClass
isImplementingInterface
in interface XClass
full_qualified_type_name
- Describe what the parameter does
public String getType()
XClass
java.lang.String.class
or java.lang.Integer.TYPE
.
getType
in interface XClass
public boolean isInner()
XClass
isInner
in interface XClass
public boolean isSubclassOf(String full_qualified_type_name, boolean superclasses)
XClass
isSubclassOf
in interface XClass
full_qualified_type_name
- Describe what the parameter doessuperclasses
- Looks in superclasses too if true
public boolean isImplementingInterface(String full_qualified_type_name, boolean superclasses)
XClass
isImplementingInterface
in interface XClass
full_qualified_type_name
- Describe what the parameter doessuperclasses
- Looks in superclasses too if true
public String getName()
Named
getName
in interface Named
public String getQualifiedName()
getQualifiedName
in interface XClass
public List getInterfaces()
getInterfaces
in interface XClass
public Collection getDeclaredInterfaces()
public XClass getSuperclass()
getSuperclass
in interface XClass
public List getDirectSubclasses()
XClass
getDirectSubclasses
in interface XClass
public List getAllSubclasses()
XClass
getAllSubclasses
in interface XClass
public List getImplementingClasses()
XClass
getImplementingClasses
in interface XClass
public List getExtendingInterfaces()
XClass
getExtendingInterfaces
in interface XClass
public XPackage getContainingPackage()
getContainingPackage
in interface XClass
getContainingPackage
in class AbstractProgramElement
public List getInnerClasses()
getInnerClasses
in interface XClass
public XProgramElement getSuperElement()
getSuperElement
in interface XProgramElement
public boolean isAnonymous()
XClass
isAnonymous
in interface XClass
public List getMethodTags(String tagName, boolean superclasses)
XClass
getMethodTags
in interface XClass
superclasses
- tagName
-
XTag
. If no tags are found, an empty
List is returned.public final int compareTo(Object o)
compareTo
in interface Comparable
compareTo
in class AbstractProgramElement
public final String toString()
toString
in class Object
public String save(File rootDir) throws IOException
save
in interface XClass
IOException
public boolean equals(Object obj)
equals
in class Object
public int hashCode()
hashCode
in class Object
public XClass qualify(String unqualifiedClassName)
qualify
in interface XClass
public long lastModified()
lastModified
in interface XClass
public void updateDoc()
updateDoc
in interface XProgramElement
updateDoc
in class AbstractProgramElement
protected final boolean hasImportedClasses()
protected final boolean hasInnerClasses()
protected final boolean hasImportedPackages()
protected void addInnerClass(XClass clazz)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |