com.helger.jcodemodel

Class JMethod

java.lang.Object

com.helger.jcodemodel.AbstractJGenerifiableImpl

com.helger.jcodemodel.JMethod

All Implemented Interfaces:

IJAnnotatable, IJDeclaration, IJDocCommentable, IJGenerifiable, IJObject, IJOwned

public class JMethod
extends AbstractJGenerifiableImpl
implements IJAnnotatable, IJDocCommentable

Java method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JMethod(int nMods, JDefinedClass aClass) Constructor for constructors
protected	JMethod(JDefinedClass aOwningClass, int nMods, AbstractJType aReturnType, String sName) Constructor for regular methods

Method Summary

Modifier and Type	Method and Description
JMethod	_throws(AbstractJClass aException) Add an exception to the list of exceptions that this method may throw.
JMethod	_throws(Class<? extends Throwable> aException)
JAnnotationUse	annotate(AbstractJClass aClazz) Adds an annotation to this variable.
JAnnotationUse	annotate(Class<? extends Annotation> aClazz) Adds an annotation to this variable.
Collection<JAnnotationUse>	annotations() Read-only live view of all annotations on this IJAnnotatable
JBlock	body() Get the block that makes up body of this method
void	declare(JFormatter f)
void	declareDefaultValue(IJExpression aDefaultValue) Specify the default value for this method
Collection<AbstractJClass>	getThrows()
boolean	hasSignature(AbstractJType[] argTypes) Returns true if the method has the specified signature.
boolean	hasVarArgs()
boolean	isConstructor()
JDocComment	javadoc()
JVar[]	listParams() Returns all the parameters in an array.
AbstractJType[]	listParamTypes() Returns all the parameter types in an array.
JVar	listVarParam() Deprecated. Use varParam() instead.
AbstractJType	listVarParamType() Returns the varags parameter type.
JMods	mods()
String	name()
void	name(String sName) Changes the name of the method.
JCodeModel	owner() Gets the owner code model object.
JDefinedClass	owningClass()
JVar	param(AbstractJType aType, String sName)
JVar	param(Class<?> aType, String sName)
JVar	param(int nMods, AbstractJType aType, String sName) Add the specified variable to the list of parameters for this method signature.
JVar	param(int nMods, Class<?> aType, String sName)
JVar	paramAtIndex(int nIndex)
List<JVar>	params() Returns the list of variable of this method.
AbstractJType	type()
void	type(AbstractJType aReturnType) Overrides the return type.
JVar	varParam()
JVar	varParam(AbstractJType aType, String sName) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(Class<?> aType, String sName) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(int nMods, AbstractJType aType, String sName) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(int nMods, Class<?> aType, String sName) Add the specified variable argument to the list of parameters for this method signature.

Methods inherited from class com.helger.jcodemodel.AbstractJGenerifiableImpl

generify, typeParams

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.jcodemodel.IJAnnotatable

annotate2

Methods inherited from interface com.helger.jcodemodel.IJGenerifiable

generify, generify

Constructor Detail

JMethod

protected JMethod(@Nonnull
                  JDefinedClass aOwningClass,
                  int nMods,
                  @Nonnull
                  AbstractJType aReturnType,
                  @Nonnull
                  String sName)

Constructor for regular methods

Parameters:

aOwningClass - Outer class. May not be null.

nMods - Modifiers for this method's declaration

aReturnType - Return type for the method. May not be null.

sName - Name of this method. May neither be null nor empty.

JMethod

protected JMethod(int nMods,
                  @Nonnull
                  JDefinedClass aClass)

Constructor for constructors

Parameters:

nMods - Modifiers for this constructor's declaration

aClass - Class containing this constructor. May not be null.

Method Detail

isConstructor

public boolean isConstructor()

getThrows

@Nonnull
public Collection<AbstractJClass> getThrows()

_throws

@Nonnull
public JMethod _throws(@Nonnull
                                 AbstractJClass aException)

Add an exception to the list of exceptions that this method may throw.

Parameters:

aException - Name of an exception that this method may throw

Returns:

this

_throws

@Nonnull
public JMethod _throws(@Nonnull
                                 Class<? extends Throwable> aException)

params

@Nonnull
public List<JVar> params()

Returns the list of variable of this method.

Returns:

List of parameters of this method. This list is not modifiable.

paramAtIndex

@Nonnull
public JVar paramAtIndex(@Nonnegative
                                   int nIndex)
                            throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

param

@Nonnull
public JVar param(int nMods,
                            @Nonnull
                            AbstractJType aType,
                            @Nonnull
                            String sName)

Add the specified variable to the list of parameters for this method signature.

Parameters:

nMods - Java modifiers to be used

aType - JType of the parameter being added

sName - Name of the parameter being added

Returns:

New parameter variable of type JVar

param

@Nonnull
public JVar param(@Nonnull
                            AbstractJType aType,
                            @Nonnull
                            String sName)

param

@Nonnull
public JVar param(int nMods,
                            @Nonnull
                            Class<?> aType,
                            @Nonnull
                            String sName)

param

@Nonnull
public JVar param(@Nonnull
                            Class<?> aType,
                            @Nonnull
                            String sName)

varParam

@Nonnull
public JVar varParam(@Nonnull
                               Class<?> aType,
                               @Nonnull
                               String sName)

Add the specified variable argument to the list of parameters for this method signature.

Parameters:

aType - Type of the parameter being added.

sName - Name of the parameter being added

Returns:

the variable parameter

Throws:

IllegalStateException - If this method is called twice. varargs in J2SE 1.5 can appear only once in the method signature.

varParam

@Nonnull
public JVar varParam(@Nonnull
                               AbstractJType aType,
                               @Nonnull
                               String sName)

Add the specified variable argument to the list of parameters for this method signature.

Parameters:

aType - Type of the parameter being added.

sName - Name of the parameter being added

Returns:

the variable parameter

Throws:

IllegalStateException - If this method is called twice. varargs in J2SE 1.5 can appear only once in the method signature.

varParam

@Nonnull
public JVar varParam(int nMods,
                               @Nonnull
                               Class<?> aType,
                               @Nonnull
                               String sName)

Add the specified variable argument to the list of parameters for this method signature.

Parameters:

nMods - nMods to use

aType - Type of the parameter being added. Is automatically converted to an array.

sName - Name of the parameter being added

Returns:

the created variable parameter

Throws:

IllegalStateException - If this method is called twice. varargs in J2SE 1.5 can appear only once in the method signature.

varParam

@Nonnull
public JVar varParam(int nMods,
                               @Nonnull
                               AbstractJType aType,
                               @Nonnull
                               String sName)

Add the specified variable argument to the list of parameters for this method signature.

Parameters:

nMods - nMods to use

aType - Type of the parameter being added. Is automatically converted to an array.

sName - Name of the parameter being added

Returns:

the created variable parameter

Throws:

IllegalStateException - If this method is called twice. varargs in J2SE 1.5 can appear only once in the method signature.

varParam

@Nullable
public JVar varParam()

hasVarArgs

public boolean hasVarArgs()

Returns:

true if there are any varargs declared for this method signature.

listVarParamType

@Nullable
public AbstractJType listVarParamType()

Returns the varags parameter type.

Returns:

If there's no vararg parameter type, null will be returned.

annotate

@Nonnull
public JAnnotationUse annotate(@Nonnull
                                         AbstractJClass aClazz)

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

aClazz - The annotation class to annotate the field with

Returns:

The created object. Never null.

annotate

@Nonnull
public JAnnotationUse annotate(@Nonnull
                                         Class<? extends Annotation> aClazz)

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

aClazz - The annotation class to annotate the field with

Returns:

The created object. Never null.

annotations

@Nonnull
public Collection<JAnnotationUse> annotations()

Description copied from interface: IJAnnotatable

Read-only live view of all annotations on this IJAnnotatable

Specified by:

annotations in interface IJAnnotatable

Returns:

Can be empty but never null.

name

public String name()

name

public void name(@Nonnull
                 String sName)

Changes the name of the method.

Parameters:

sName - New name

type

@Nullable
public AbstractJType type()

Returns:

the return type. Is null for constructors.

type

public void type(@Nullable
                 AbstractJType aReturnType)

Overrides the return type.

Parameters:

aReturnType - The type to set. Set to null to make this method a constructor.

listParamTypes

@Nonnull
public AbstractJType[] listParamTypes()

Returns all the parameter types in an array.

Returns:

If there's no parameter, an empty array will be returned.

listParams

@Nonnull
public JVar[] listParams()

Returns all the parameters in an array.

Returns:

If there's no parameter, an empty array will be returned.

listVarParam

@Nullable
 @Deprecated
public JVar listVarParam()

Deprecated. Use varParam() instead.

Returns the variable parameter

Returns:

If there's no parameter, null will be returned.

hasSignature

public boolean hasSignature(@Nonnull
                            AbstractJType[] argTypes)

Returns true if the method has the specified signature.

Parameters:

argTypes - Signature to check

Returns:

true if this method has the provided signature

body

@Nonnull
public JBlock body()

Get the block that makes up body of this method

Returns:

Body of method. Never null.

declareDefaultValue

public void declareDefaultValue(@Nullable
                                IJExpression aDefaultValue)

Specify the default value for this method

Parameters:

aDefaultValue - Default value for the method

javadoc

@Nonnull
public JDocComment javadoc()

Specified by:

javadoc in interface IJDocCommentable

Returns:

the JavaDoc of this element. Never null.

declare

public void declare(@Nonnull
                    JFormatter f)

Specified by:

declare in interface IJDeclaration

Overrides:

declare in class AbstractJGenerifiableImpl

mods

@Nonnull
public JMods mods()

Returns:

the current modifiers of this method. Always return non-null valid object.

owningClass

@Nonnull
public JDefinedClass owningClass()

Returns:

The JDefinedClass to which this methods belongs. Never null.

owner

@Nonnull
public JCodeModel owner()

Description copied from interface: IJOwned

Gets the owner code model object.

Specified by:

owner in interface IJOwned

Returns:

The owner and never null.