com.helger.jcodemodel

Class JMethod

java.lang.Object

com.helger.jcodemodel.AbstractJGenerifiableImpl

com.helger.jcodemodel.JMethod

All Implemented Interfaces:

IJAnnotatable, IJDeclaration, IJDocCommentable, IJGenerifiable, IJOwned

public class JMethod
extends AbstractJGenerifiableImpl
implements IJAnnotatable, IJDocCommentable

Java method.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JMethod(int mods, JDefinedClass aClass) Constructor for constructors
protected	JMethod(JDefinedClass outer, int mods, AbstractJType type, String name) Constructor for regular methods

Method Summary

Methods

Modifier and Type	Method and Description
JMethod	_throws(AbstractJClass exception) Add an exception to the list of exceptions that this method may throw.
JMethod	_throws(Class<? extends Throwable> exception)
JAnnotationUse	annotate(AbstractJClass clazz) Adds an annotation to this variable.
JAnnotationUse	annotate(Class<? extends Annotation> clazz) Adds an annotation to this variable.
<W extends IJAnnotationWriter<?>> W	annotate2(Class<W> clazz) Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.
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() Creates, if necessary, and returns the class javadoc for this JMethod.
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 n) Changes the name of the method.
JCodeModel	owner() Gets the owner code model object.
JVar	param(AbstractJType type, String name)
JVar	param(Class<?> type, String name)
JVar	param(int mods, AbstractJType type, String name) Add the specified variable to the list of parameters for this method signature.
JVar	param(int mods, Class<?> type, String name)
JVar	paramAtIndex(int index)
List<JVar>	params() Returns the list of variable of this method.
AbstractJType	type()
void	type(AbstractJType t) Overrides the return type.
JVar	varParam()
JVar	varParam(AbstractJType type, String name) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(Class<?> type, String name) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(int mods, AbstractJType type, String name) Add the specified variable argument to the list of parameters for this method signature.
JVar	varParam(int mods, Class<?> type, String name) Add the specified variable argument to the list of parameters for this method signature.

Methods inherited from class com.helger.jcodemodel.AbstractJGenerifiableImpl

generify, generify, generify, typeParamList, typeParams

Methods inherited from class java.lang.Object

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

Constructor Detail

JMethod

protected JMethod(@Nonnull
       JDefinedClass outer,
       int mods,
       AbstractJType type,
       String name)

Constructor for regular methods

Parameters:

outer - Outer class

mods - Modifiers for this method's declaration

type - Return type for the method

name - Name of this method

JMethod

protected JMethod(int mods,
       @Nonnull
       JDefinedClass aClass)

Constructor for constructors

Parameters:

mods - Modifiers for this constructor's declaration

aClass - JClass containing this constructor

Method Detail

isConstructor

public boolean isConstructor()

getThrows

@Nonnull
public Collection<AbstractJClass> getThrows()

_throws

@Nonnull
public JMethod _throws(@Nonnull
                      AbstractJClass exception)

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

Parameters:

exception - Name of an exception that this method may throw

Returns:

this

_throws

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

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 index)

param

@Nonnull
public JVar param(int mods,
                 @Nonnull
                 AbstractJType type,
                 @Nonnull
                 String name)

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

Parameters:

mods - Java modifiers to be used

type - JType of the parameter being added

name - Name of the parameter being added

Returns:

New parameter variable of type JVar

param

@Nonnull
public JVar param(@Nonnull
                 AbstractJType type,
                 @Nonnull
                 String name)

param

@Nonnull
public JVar param(int mods,
                 @Nonnull
                 Class<?> type,
                 @Nonnull
                 String name)

param

@Nonnull
public JVar param(@Nonnull
                 Class<?> type,
                 @Nonnull
                 String name)

varParam

@Nonnull
public JVar varParam(@Nonnull
                    Class<?> type,
                    @Nonnull
                    String name)

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

Parameters:

type - Type of the parameter being added.

name - 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 type,
                    @Nonnull
                    String name)

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

Parameters:

type - Type of the parameter being added.

name - 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 mods,
                    @Nonnull
                    Class<?> type,
                    @Nonnull
                    String name)

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

Parameters:

mods - mods to use

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

name - 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 mods,
                    @Nonnull
                    AbstractJType type,
                    @Nonnull
                    String name)

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

Parameters:

mods - mods to use

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

name - 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 clazz)

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

Returns:

The created object. Never null.

annotate

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

Adds an annotation to this variable.

Specified by:

annotate in interface IJAnnotatable

Parameters:

clazz - The annotation class to annotate the field with

Returns:

The created object. Never null.

annotate2

@Nonnull
public <W extends IJAnnotationWriter<?>> W annotate2(@Nonnull
                                                    Class<W> clazz)

Description copied from interface: IJAnnotatable

Adds an annotation to this program element and returns a type-safe writer to fill in the values of such annotations.

Specified by:

annotate2 in interface IJAnnotatable

Type Parameters:

W - Implementation type

Parameters:

clazz - Source class

Returns:

Instance of the source class

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(String n)

Changes the name of the method.

Parameters:

n - New name

type

@Nullable
public AbstractJType type()

Returns:

the return type. Is null for constructors.

type

public void type(@Nullable
        AbstractJType t)

Overrides the return type.

Parameters:

t - 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()

Creates, if necessary, and returns the class javadoc for this JMethod.

Specified by:

javadoc in interface IJDocCommentable

Returns:

JDocComment containing javadocs for this class. 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.

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.