org.codehaus.modello.generator.java.javasource

Class JInterface

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 modelled after the Java Reflection API as much as possible to reduce the learning curve.

Version: $Revision: 510 $ $Date: 2005-12-09 00:03:20 -0500 (Fri, 09 Dec 2005) $

Author: Martin Skopp Keith Visco

Constructor Summary
JInterface(String name)
Creates a new JInterface with the given name.
Method Summary
voidaddField(JField jField)
Adds the given JField to this JStructure.
voidaddMember(JMember jMember)
Adds the given JMember to this JStructure.
voidaddMethod(JMethodSignature jMethodSig)
Adds the given JMethodSignature to this JClass
JFieldgetField(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 JStructure
JMethodSignaturegetMethod(String name, int startIndex)
Returns the JMethodSignature with the given name, and occuring at or after the given starting index.
JMethodSignaturegetMethod(int index)
Returns the JMethodSignature at the given index.
JMethodSignature[]getMethods()
Returns an array of all the JMethodSignatures of this JInterface.
voidprint(JSourceWriter jsw)
Prints the source code for this JInterface to the given JSourceWriter
voidprint(JSourceWriter jsw, boolean classOnly)
Prints the source code for this JInterface to the given JSourceWriter

Constructor Detail

JInterface

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

Parameters: name the name of the JInterface.

Throws: java.lang.IllegalArgumentException when the given name is not a valid Class name.

Method Detail

addField

public void addField(JField jField)
Adds the given JField to this JStructure.

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.

Parameters: jField, the JField to add

Throws: java.lang.IllegalArgumentException when the given JField has a name of an existing JField

addMember

public void addMember(JMember jMember)
Adds the given JMember to this JStructure.

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

Parameters: jMember the JMember to add to this JStructure.

Throws: java.lang.IllegalArgumentException when the given JMember has the same name of an existing JField or JMethod respectively.

addMethod

public void addMethod(JMethodSignature jMethodSig)
Adds the given JMethodSignature to this JClass

Parameters: jMethodSig the JMethodSignature to add.

Throws: java.lang.IllegalArgumentException when the given JMethodSignature conflicts with an existing method signature.

getField

public JField getField(String name)
Returns the field with the given name, or null if no field was found with the given name.

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.

getFields

public JField[] getFields()
Returns an array of all the JFields of this JStructure

Returns: an array of all the JFields of this JStructure

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.

getMethods

public JMethodSignature[] getMethods()
Returns an array of all the JMethodSignatures of this JInterface.

Returns: an array of all the JMethodSignatures of this JInterface.

print

public void print(JSourceWriter jsw)
Prints the source code for this JInterface to the given JSourceWriter

Parameters: jsw the JSourceWriter to print to. [May not be null]

print

public void print(JSourceWriter jsw, boolean classOnly)
Prints the source code for this JInterface to the given JSourceWriter

Parameters: jsw the JSourceWriter to print to. [May not be null]

Copyright © 2001-2009 Codehaus. All Rights Reserved.