org.freehep.rtti
Class IClass

java.lang.Object
  org.freehep.rtti.IClass

public class IClass
extends Object

Defines a class/interface in the RTTI.

Version:

$Id: IClass.java 8584 2006-08-10 23:06:37Z duns $

Author:

Mark Donszelmann

Method Summary

String[]	getComments(String language) Returns the list of comments describing this class.
IConstructor[]	getConstructors() Returns the list of constructors defined in this class.
IDestructor	getDestructor() Returns the destructor defined in this class.
IField[]	getEnumFields()
String[]	getEOCComments(String language) Returns the list of end-of-class comments.
String[]	getEOFComments(String language) Returns the list of end-of-file comments.
String[]	getEOPComments(String language) Returns the list of end-of-package comments.
IField[]	getFields() Returns the list of fields (including static ones) defined in this class
String[]	getInterfaces() Returns the list of interfaces, implemented by this class.
IMethod[]	getMethods() Returns the list of methods (including static ones) defined in this class
String	getName() returns the name of this class
String[]	getPackageComments(String language) Returns the list of package comments describing this class.
String	getPackageName() Returns the package name
String	getPackageName(String packagePrefix) Returns the package name, consisting of the prefix and the defined package name.
String[]	getTemplateParameters() Returns the list of template parameters used by this class.
boolean	isClass() returns true if this is a class
void	setEnumFields(Vector enumFields)
void	setEOFComments(Vector eofComments)
void	setEOPComments(Vector eopComments)
String	toString() Semi-java string representation of this class without package prefix.
String	toString(String packagePrefix) Semi-java string representation of this class without package prefix.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public String getName()

returns the name of this class

Returns:

name of the class (unqualified)

isClass

public boolean isClass()

returns true if this is a class

Returns:

true if this is a class

getPackageName

public String getPackageName()

Returns the package name

Returns:

full package name

getPackageName

public String getPackageName(String packagePrefix)

Returns the package name, consisting of the prefix and the defined package name.

Parameters:

packagePrefix - prefix to be prefix to the defined package name, or null, if not necessary.

Returns:

full package name including prefix

getPackageComments

public String[] getPackageComments(String language)

Returns the list of package comments describing this class.

Returns:

list of package comments.

getComments

public String[] getComments(String language)

Returns the list of comments describing this class.

Returns:

list of comments.

getEOCComments

public String[] getEOCComments(String language)

Returns the list of end-of-class comments.

Returns:

list of comments.

getEOPComments

public String[] getEOPComments(String language)

Returns the list of end-of-package comments.

Returns:

list of comments.

setEOPComments

public void setEOPComments(Vector eopComments)

getEOFComments

public String[] getEOFComments(String language)

Returns the list of end-of-file comments.

Returns:

list of comments.

setEOFComments

public void setEOFComments(Vector eofComments)

getEnumFields

public IField[] getEnumFields()

setEnumFields

public void setEnumFields(Vector enumFields)

getTemplateParameters

public String[] getTemplateParameters()

Returns the list of template parameters used by this class.

Returns:

list of template parameter names

getInterfaces

public String[] getInterfaces()

Returns the list of interfaces, implemented by this class.

Returns:

list of interface names

getConstructors

public IConstructor[] getConstructors()

Returns the list of constructors defined in this class.

Returns:

list of constructors

getDestructor

public IDestructor getDestructor()

Returns the destructor defined in this class.

Returns:

destructor

getMethods

public IMethod[] getMethods()

Returns the list of methods (including static ones) defined in this class

Returns:

list of methods

getFields

public IField[] getFields()

Returns the list of fields (including static ones) defined in this class

Returns:

list of fields

toString

public String toString()

Semi-java string representation of this class without package prefix.

Overrides:

toString in class Object

Returns:

Semi-java string representation of this class without package prefix.

toString

public String toString(String packagePrefix)

Semi-java string representation of this class without package prefix.

Parameters:

packagePrefix - prefix to be used in the string representation.

Returns:

Semi-java string representation of this class without package prefix.