xjavadoc

Class AbstractClass

public abstract class AbstractClass extends AbstractProgramElement implements XClass

Base implementation of XClass.

Author: Ara Abrahamian Aslak Hellesxy

UNKNOWN: 18. oktober 2002

Field Summary
List	_allInterfaces The implemented interfaces according to the hierarchy
List	_allSubclasses
List	_constructors
XPackage	_containingPackage
List	_declaredInterfaces The implemented interfaces according to the source
List	_directSubclasses
List	_extendingInterfaces
List	_fields
int	_hash
List	_implementingClasses
List	_importedClasses
List	_importedClassNames
List	_importedPackages
List	_innerClasses
boolean	_isAnonymous
boolean	_isInterface
List	_methods
String	_name
Map	_namedConstructors
HashMap	_namedMethods
String	_qualifiedName
XClass	_superclass
String	_transformedName
String	_transformedQualifiedName

Constructor Summary
protected	AbstractClass(AbstractClass containingClass, XTagFactory tagFactory)
protected	AbstractClass(XJavaDoc xJavaDoc, XTagFactory tagFactory)

Method Summary
void	addConstructor(XConstructor constructor) Gets the Constructors attribute of the AbstractClass object
void	addField(XField field) Gets the Fields attribute of the AbstractClass object
void	addImportedClass(String importedClass) Sets the ImportedClasses attribute of the AbstractClass object
void	addImportedPackage(String importedPackage) Sets the ImportedPackages attribute of the AbstractClass object
protected void	addInnerClass(XClass clazz)
void	addInterface(String interfaceName) Adds an interface that this class implements (if this is a class) or an interface that this interface extends (if this is an interface)
void	addMethod(XMethod method) Gets the Methods attribute of the AbstractClass object
int	compareTo(Object o)
boolean	equals(Object obj)
List	getAllSubclasses()
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()
List	getExtendingInterfaces()
XField	getField(String fieldName) Returns an XField with the given name.
List	getFields(Predicate predicate, boolean superclasses)
List	getFields(boolean superclasses)
List	getFields() Describe what the method does
List	getImplementingClasses()
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)
List	getMembers(boolean superclasses, boolean forFields) Returns all the fields or methods.
XMethod	getMethod(String methodNameWithSignature)
XMethod	getMethod(String methodNameWithSignature, boolean superclasses)
List	getMethods()
List	getMethods(Predicate predicate, boolean superclasses)
List	getMethods(boolean superclasses)
List	getMethodTags(String tagName, boolean superclasses)
String	getName()
String	getQualifiedName() Describe what the method does
XClass	getSuperclass() Describe what the method does
XProgramElement	getSuperElement() Describe what the method does
List	getSuperInterfaceElements()
String	getTransformedName() Gets the transformed class name, for example: `Character$Subset`
String	getTransformedQualifiedName() Gets the transformed qualified class name, for example: `java.lang.Character$Subset`
String	getType()
int	hashCode()
protected boolean	hasImportedClasses()
protected boolean	hasImportedPackages()
protected boolean	hasInnerClasses()
void	initializeNamedConstructorsHashMap()
void	initializeNamedMethodsHashMap()
boolean	isA(String full_qualified_type_name)
boolean	isA(String full_qualified_type_name, boolean superclasses)
boolean	isAnonymous()
boolean	isImplementingInterface(String full_qualified_type_name)
boolean	isImplementingInterface(String full_qualified_type_name, boolean superclasses)
boolean	isInner()
boolean	isInterface() Gets the Interface attribute of the SourceClass object
boolean	isSubclassOf(String full_qualified_type_name)
boolean	isSubclassOf(String full_qualified_type_name, boolean superclasses)
long	lastModified()
XClass	qualify(String unqualifiedClassName)
void	reset()
void	resolveImportedClasses()
String	save(File rootDir)
void	setContainingPackage(String containingPackage) Sets the ContainingPackage attribute of the AbstractProgramElement object Use package name specified in class, and do not complain about directory struct.
void	setInterface(boolean flag) Sets the Interface attribute of the SourceClass object
void	setName(String name) Sets the unqualified name of the class.
void	setQualifiedName(String qualifiedName) Sets the qualified name of the class.
void	setRealised(String clazz) This method is called for anonymous classes only.
void	setSuperclass(String superclass) Sets the SuperClass attribute of the SourceClass object
String	toString()
void	updateDoc() update javadoc
void	validate(XMember member)

Field Detail

_allInterfaces

private List _allInterfaces

The implemented interfaces according to the hierarchy

_declaredInterfaces

private List _declaredInterfaces

The implemented interfaces according to the source

_transformedQualifiedName

private String _transformedQualifiedName

Constructor Detail

AbstractClass

protected AbstractClass(AbstractClass containingClass, XTagFactory tagFactory)

AbstractClass

protected AbstractClass(XJavaDoc xJavaDoc, XTagFactory tagFactory)

Method Detail

addConstructor

void addConstructor(XConstructor constructor)

Gets the Constructors attribute of the AbstractClass object

Parameters: constructor Describe the method parameter

addField

void addField(XField field)

Gets the Fields attribute of the AbstractClass object

Parameters: field Describe the method parameter

addImportedClass

void addImportedClass(String importedClass)

Sets the ImportedClasses attribute of the AbstractClass object

Parameters: importedClass Describe the method parameter

addImportedPackage

void addImportedPackage(String importedPackage)

Sets the ImportedPackages attribute of the AbstractClass object

Parameters: importedPackage Describe the method parameter

addInnerClass

protected void addInnerClass(XClass clazz)

addInterface

final void addInterface(String interfaceName)

Adds an interface that this class implements (if this is a class) or an interface that this interface extends (if this is an interface)

Parameters: interfaceName Describe the method parameter

addMethod

void addMethod(XMethod method)

Gets the Methods attribute of the AbstractClass object

Parameters: method Describe the method parameter

getConstructor

public final XConstructor getConstructor(String constructorNameWithSignature)

Gets the Constructor attribute of the AbstractClass object

Parameters: constructorNameWithSignature Describe what the parameter does

Returns: The Constructor value

getConstructors

public final List getConstructors()

Gets the constructors.

Returns: the constructors.

getContainingPackage

public XPackage getContainingPackage()

Describe what the method does

Returns: Describe the return value

getDeclaredInterfaces

public Collection getDeclaredInterfaces()

Returns the interfaces that are declared in the source code. This excludes any interfaces that might be implicitly implemented. This method is only useful for CodeUnit, which compares source codes, and should normally not be called.

Returns: A Collection of XClass

getDirectSubclasses

public List getDirectSubclasses()

getExtendingInterfaces

public List getExtendingInterfaces()

getField

public final XField getField(String fieldName)

Returns an XField with the given name. Example: getField("id");

Parameters: fieldName Describe what the parameter does

Returns: The Field value

getFields

public final List getFields(Predicate predicate, boolean superclasses)

getFields

public final List getFields(boolean superclasses)

getFields

public final List getFields()

Describe what the method does

Returns: Describe the return value for method for return value

getImplementingClasses

public List getImplementingClasses()

getImportedClasses

public final List getImportedClasses()

Describe what the method does

Returns: Describe the return value for method for return value

getImportedPackages

public final List getImportedPackages()

Describe what the method does

Returns: Describe the return value for method for return value

getInnerClasses

public List getInnerClasses()

Describe what the method does

Returns: Describe the return value

getInterfaces

public List getInterfaces()

Returns all the implemented interfaces (if this is a class) or all the extended interfaces (if this is an interface)

Returns: Describe the return value for method for return value

getMembers

private final List getMembers(boolean superclasses, boolean forFields)

Returns all the fields or methods.

Parameters: forFields true if you want the fields, false if you want methods superclasses

Returns: A List of XMember

getMethod

public final XMethod getMethod(String methodNameWithSignature)

getMethod

public final XMethod getMethod(String methodNameWithSignature, boolean superclasses)

getMethods

public final List getMethods()

getMethods

public final List getMethods(Predicate predicate, boolean superclasses)

getMethods

public final List getMethods(boolean superclasses)

getMethodTags

public List getMethodTags(String tagName, boolean superclasses)

getName

public String getName()

getQualifiedName

public String getQualifiedName()

Describe what the method does

Returns: Describe the return value for method for return value

getSuperclass

public XClass getSuperclass()

Describe what the method does

Returns: Describe the return value for method for return value

getSuperElement

public XProgramElement getSuperElement()

Describe what the method does

Returns: Describe the return value

getSuperInterfaceElements

public List getSuperInterfaceElements()

getTransformedName

public String getTransformedName()

Gets the transformed class name, for example: Character$Subset

Returns: the transformed class name.

getTransformedQualifiedName

public String getTransformedQualifiedName()

Gets the transformed qualified class name, for example: java.lang.Character$Subset

Returns: the transformed qualified class name.

getType

public String getType()

hashCode

public int hashCode()

hasImportedClasses

protected final boolean hasImportedClasses()

hasImportedPackages

protected final boolean hasImportedPackages()

hasInnerClasses

protected final boolean hasInnerClasses()

initializeNamedConstructorsHashMap

private void initializeNamedConstructorsHashMap()

initializeNamedMethodsHashMap

private void initializeNamedMethodsHashMap()

isA

public final boolean isA(String full_qualified_type_name)

isA

public final boolean isA(String full_qualified_type_name, boolean superclasses)

isAnonymous

public boolean isAnonymous()

isImplementingInterface

public final boolean isImplementingInterface(String full_qualified_type_name)

isImplementingInterface

public boolean isImplementingInterface(String full_qualified_type_name, boolean superclasses)

isInner

public boolean isInner()

isInterface

public final boolean isInterface()

Gets the Interface attribute of the SourceClass object

Returns: The Interface value

isSubclassOf

public final boolean isSubclassOf(String full_qualified_type_name)

isSubclassOf

public boolean isSubclassOf(String full_qualified_type_name, boolean superclasses)

lastModified

public long lastModified()

qualify

public XClass qualify(String unqualifiedClassName)

reset

void reset()

resolveImportedClasses

void resolveImportedClasses()

save

public String save(File rootDir)

setContainingPackage

final void setContainingPackage(String containingPackage)

Sets the ContainingPackage attribute of the AbstractProgramElement object Use package name specified in class, and do not complain about directory struct.

Parameters: containingPackage The new ContainingPackage value