public final class JInterface extends JStructure
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,JField> |
fields
The fields for this JInterface
|
private java.util.List<JMethodSignature> |
methods
The list of methods of this JInterface
|
private java.util.List<java.lang.String> |
sourceCodeEntries |
DEFAULT_HEADER, version
Constructor and Description |
---|
JInterface(java.lang.String name)
Creates a new JInterface with the given name.
|
Modifier and Type | Method and Description |
---|---|
void |
addField(JField jField)
Adds the given JField to this JStructure.
|
void |
addMember(JMember jMember)
Adds the given JMember to this JStructure.
|
void |
addMethod(JMethodSignature jMethodSig)
Adds the given JMethodSignature to this JClass
|
void |
addSourceCode(java.lang.String sourceCode) |
JField |
getField(java.lang.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
|
JMethodSignature |
getMethod(int index)
Returns the JMethodSignature at the given index.
|
JMethodSignature |
getMethod(java.lang.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)
Prints the source code for this JInterface to the given JSourceWriter
|
void |
print(JSourceWriter jsw,
boolean classOnly)
Prints the source code for this JInterface to the given JSourceWriter
|
addImport, addInterface, addInterface, appendAnnotation, getAnnotations, getFilename, getHeader, getImports, getInterfaceCount, getInterfaces, getJDocComment, getModifiers, getName, getPackageFromClassName, getPackageName, hasImport, isAbstract, isValidClassName, print, print, printHeader, printImportDeclarations, printlnWithPrefix, printPackageDeclaration, removeImport, setAnnotations, setHeader, setPackageName
changePackage, createArray, getComponentType, getLocalName, getName, isArray, isPrimitive, toString
private java.util.Map<java.lang.String,JField> fields
private java.util.List<JMethodSignature> methods
private java.util.List<java.lang.String> sourceCodeEntries
public JInterface(java.lang.String name) throws java.lang.IllegalArgumentException
name
- the name of the JInterface.java.lang.IllegalArgumentException
- when the given name
is not a valid Class name.public void addField(JField jField) throws java.lang.IllegalArgumentException
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.
addField
in class JStructure
jField,
- the JField to addjava.lang.IllegalArgumentException
- when the given
JField has a name of an existing JFieldpublic void addMember(JMember jMember) throws java.lang.IllegalArgumentException
This method is implemented by subclasses and should only accept the proper types for the subclass otherwise an IllegalArgumentException will be thrown.
addMember
in class JStructure
jMember
- the JMember to add to this JStructure.java.lang.IllegalArgumentException
- when the given
JMember has the same name of an existing JField
or JMethod respectively.public void addMethod(JMethodSignature jMethodSig) throws java.lang.IllegalArgumentException
jMethodSig
- the JMethodSignature to add.java.lang.IllegalArgumentException
- when the given
JMethodSignature conflicts with an existing
method signature.public JField getField(java.lang.String name)
getField
in class JStructure
name
- the name of the field to return.public JField[] getFields()
getFields
in class JStructure
public JMethodSignature[] getMethods()
public JMethodSignature getMethod(java.lang.String name, int startIndex)
name
- the name of the JMethodSignature to return.startIndex
- the starting index to begin searching
from.public JMethodSignature getMethod(int index)
index
- the index of the JMethodSignature to return.public void print(JSourceWriter jsw)
print
in class JStructure
jsw
- the JSourceWriter to print to. [May not be null]public void print(JSourceWriter jsw, boolean classOnly)
jsw
- the JSourceWriter to print to. [May not be null]classOnly
- whether the header, package and imports should be printed toopublic void addSourceCode(java.lang.String sourceCode)