Class JInterface

java.lang.Object

org.exolab.javasource.JType

org.exolab.javasource.JStructure

org.exolab.javasource.JInterface

All Implemented Interfaces:

JAnnotatedElement

public final class JInterface
extends JStructure

A representation of the Java Source code for a Java Interface. This is a useful utility when creating in memory source code. The code in this package was modeled after the Java Reflection API as much as possible to reduce the learning curve.

Version:

$Revision: 8329 $ $Date: 2005-02-26 17:30:28 -0700 (Sat, 26 Feb 2005) $

Author:

Martin Skopp, Keith Visco

Field Summary

Fields inherited from class JType

BOOLEAN, BYTE, CHAR, DOUBLE, FLOAT, INT, LONG, SHORT

Modifier and Type	Field	Description
static final JPrimitiveType	BOOLEAN	JType for a boolean (Boolean).
static final JPrimitiveType	BYTE	JType instance for a byte (Byte).
static final JPrimitiveType	CHAR	JType instance for a char (Char).
static final JPrimitiveType	DOUBLE	JType instance for a double (Double).
static final JPrimitiveType	FLOAT	JType instance for a float (Float).
static final JPrimitiveType	INT	JType instance for a int (Integer).
static final JPrimitiveType	LONG	JType instance for a long (Long).
static final JPrimitiveType	SHORT	JType instance for a short (Short).

Constructor Summary

Constructors

Constructor	Description
JInterface(String name)	Creates a new JInterface with the given name.

Method Summary

Modifier and Type	Method	Description
void	addField(JField jField)	Adds the given JField to this Jinterface.
void	addImport(String className)	Adds the given import to this JStructure.
void	addMember(JMember jMember)	Adds the given JMember to this Jinterface.
void	addMethod(JMethodSignature jMethodSig)	Adds the given JMethodSignature to this Jinterface.
JField	getField(String name)	Returns the field with the given name, or null if no field was found with the given name.
JField[]	getFields()	Returns an array of all the JFields of this Jinterface.
JMethodSignature	getMethod(int index)	Returns the JMethodSignature at the given index.
JMethodSignature	getMethod(String name, int startIndex)	Returns the JMethodSignature with the given name and occuring at or after the given starting index.
JMethodSignature[]	getMethods()	Returns an array of all the JMethodSignatures of this JInterface.
void	print(JSourceWriter jsw)	Deprecated. Please use the Velocity-template based approach instead.
void	print(JSourceWriter jsw, boolean classOnly)	Deprecated. Please use the Velocity-template based approach instead.

Methods inherited from class JStructure

addAnnotation, addImport, addImport, addImportInternal, addInterface, getAnnotatedElementHelper, getAnnotation, getAnnotations, getFilename, getHeader, getImportCount, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getPackageName, hasAnnotations, hasImport, isAnnotationPresent, print, printHeader, printImportDeclarations, printPackageDeclaration, removeAnnotation, removeImport, removeInterface, setHeader, toString

Modifier and Type	Method	Description
final void	addAnnotation(JAnnotation annotation)	Adds a JAnnotation to this source element.
protected final void	addImport(JAnnotation annotation)	Adds appropriate import for this JAnnotation.
protected final void	addImport(JAnnotation[] annotations)	Adds appropriate imports for each JAnnotation in the given Array.
protected final void	addImportInternal(String className)	Adds the given import to this JStructure.
final void	addInterface(String interfaceName)	Adds the given interface to the list of interfaces this JStructure inherits method declarations from, and either implements (JClass) or extends (JInterface).
protected final JAnnotatedElementHelper	getAnnotatedElementHelper()	Returns the object managing the annotations for this JStructure.
final JAnnotation	getAnnotation(JAnnotationType annotationType)	Retrieves a JAnnotation for the given JAnnotationType, returns null if no annotation has been set.
final JAnnotation[]	getAnnotations()	Returns a list of JAnnotation's already set on this source element.
final String	getFilename(String destDir)	Returns the name of the file that this JStructure would be printed to, given a call to JStructure.print(String, String).
final JComment	getHeader()	Returns the JComment header to display at the top of the source file for this JStructure, or null if no header was set.
final int	getImportCount()	Returns the amount of imports.
final Enumeration<String>	getImports()	Returns an Enumeration of imported package and class names for this JStructure.
final int	getInterfaceCount()	Return the count of the number of Interfaces that have been added to this JStructure.
final Enumeration<String>	getInterfaces()	Returns an Enumeration of interface names that this JStructure inherits from.
final JDocComment	getJDocComment()	Returns the JavaDoc comment for this JStructure.
final JModifiers	getModifiers()	Returns the JModifiers, which allows the qualifiers to be changed.
final String	getPackageName()	Returns the name of the package that this JStructure is a member of.
final boolean	hasAnnotations()	Returns true if this source element has any annotations.
final boolean	hasImport(String classname)	Returns true if the given classname exists in the imports of this JStructure.
final boolean	isAnnotationPresent(JAnnotationType annotationType)	Returns true if a JAnnotation exists for the given JAnnotationType.
final void	print(String destDir, String lineSeparator)	Prints the source code for this JStructure to the destination directory.
final void	printHeader(JSourceWriter jsw)	A utility method that prints the header to the given JSourceWriter.
protected final void	printImportDeclarations(JSourceWriter jsw)	A utility method that prints the imports to the given JSourceWriter.
final void	printPackageDeclaration(JSourceWriter jsw)	A utility method that prints the packageDeclaration to the given JSourceWriter.
final JAnnotation	removeAnnotation(JAnnotationType annotationType)	Removes the JAnnotation from this source element for the given JAnnotationType.
final boolean	removeImport(String className)	Remove the import of the given class name from this JStucture, returning true if the import was found and removed.
final boolean	removeInterface(String interfaceName)	Removes the given interface from the list of interfaces this JStructure has.
final void	setHeader(JComment comment)	Sets the header comment for this JStructure.
final String	toString()	Returns the String representation of this JType.

Methods inherited from class JType

getLocalName, getName, isArray, isPrimitive, setName

Modifier and Type	Method	Description
final String	getLocalName()	Returns the unqualified Java type name (i.e.
final String	getName()	Returns the qualified Java type name.
final boolean	isArray()	Returns true if this type represents an Array.
final boolean	isPrimitive()	Returns true if this type represents a Java primitive type.
protected void	setName(String name)	Sets the qualified name of this type.

Methods inherited from class Object

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

Constructor Details

JInterface

public JInterface(String name)

Creates a new JInterface with the given name.

Parameters:

name - The name of the JInterface.

Method Details

addImport

public void addImport(String className)

Adds the given import to this JStructure. Note: You cannot import from the "default package," so imports with no package are ignored.

Specified by:

addImport in class JStructure

Parameters:

className - Name of the class to import.

addMember

public void addMember(JMember jMember)

Adds the given JMember to this Jinterface.

This method is implemented by subclasses and should only accept the proper types for the subclass otherwise an IllegalArgumentException will be thrown.

Specified by:

addMember in class JStructure

Parameters:

jMember - The JMember to add to this JStructure.

getFields

public JField[] getFields()

Returns an array of all the JFields of this Jinterface.

Specified by:

getFields in class JStructure

Returns:

An array of all the JFields of this Jinterface.

getField

public JField getField(String name)

Returns the field with the given name, or null if no field was found with the given name.

Specified by:

getField in class JStructure

Parameters:

name - The name of the field to return.

Returns:

The field with the given name, or null if no field was found with the given name.

addField

public void addField(JField jField)

Adds the given JField to this Jinterface.

This method is implemented by subclasses and should only accept the proper fields for the subclass otherwise an IllegalArgumentException will be thrown. For example a JInterface will only accept static fields.

Specified by:

addField in class JStructure

Parameters:

jField - The JField to add.

getMethods

public JMethodSignature[] getMethods()

Returns an array of all the JMethodSignatures of this JInterface.

Returns:

An array of all the JMethodSignatures of this JInterface.

getMethod

public JMethodSignature getMethod(String name,
 int startIndex)

Returns the JMethodSignature with the given name and occuring at or after the given starting index.

Parameters:

name - The name of the JMethodSignature to return.

startIndex - The starting index to begin searching from.

Returns:

The JMethodSignature, or null if not found.

getMethod

public JMethodSignature getMethod(int index)

Returns the JMethodSignature at the given index.

Parameters:

index - The index of the JMethodSignature to return.

Returns:

The JMethodSignature at the given index.

addMethod

public void addMethod(JMethodSignature jMethodSig)

Adds the given JMethodSignature to this Jinterface.

Parameters:

jMethodSig - The JMethodSignature to add.

print

public void print(JSourceWriter jsw)

Deprecated.

Please use the Velocity-template based approach instead.

Prints the source code for this JStructure to the given JSourceWriter.

Specified by:

print in class JStructure

Parameters:

jsw - The JSourceWriter to print to.

See Also:

• invalid reference

  SourceGenerator#setJClassPrinterType(String)

print

public void print(JSourceWriter jsw,
 boolean classOnly)

Deprecated.

Please use the Velocity-template based approach instead.

Prints the source code for this JInterface to the given JSourceWriter.

Parameters:

jsw - The JSourceWriter to print to. Must not be null.

classOnly - If true, generates the class body without the class header, package declaration, or imports.

See Also:

• invalid reference

  SourceGenerator#setJClassPrinterType(String)