Package org.jboss.forge.roaster.model.source

Interface MethodSource<O extends JavaSource<O>>

All Superinterfaces:

Abstractable, AbstractableSource<MethodSource<O>>, AnnotationTarget<O>, AnnotationTargetSource<O,MethodSource<O>>, FinalCapable, FinalCapableSource<MethodSource<O>>, GenericCapable<O>, GenericCapableSource<O,MethodSource<O>>, Internal, JavaDocCapable<MethodSource<O>>, JavaDocCapableSource<MethodSource<O>>, LocationCapable, Member<O>, MemberSource<O,MethodSource<O>>, Method<O,MethodSource<O>>, Named, NamedSource<MethodSource<O>>, Origin<O>, StaticCapable, StaticCapableSource<MethodSource<O>>, VisibilityScoped, VisibilityScopedSource<MethodSource<O>>

public interface MethodSource<O extends JavaSource<O>>
extends Method<O,MethodSource<O>>, AbstractableSource<MethodSource<O>>, MemberSource<O,MethodSource<O>>, GenericCapableSource<O,MethodSource<O>>

Represents a Java Method in source form.

Author:

Lincoln Baxter, III, George Gastaldi

Method Summary

Modifier and Type	Method	Description
ParameterSource<O>	addParameter(java.lang.Class<?> type, java.lang.String name)	Add a parameter with the specified Class type and name to this method
ParameterSource<O>	addParameter(java.lang.String type, java.lang.String name)	Add a parameter with the specified type and name to this method
ParameterSource<O>	addParameter(JavaType<?> type, java.lang.String name)	Add a parameter with the specified JavaType type and name to this method
MethodSource<O>	addThrows(java.lang.Class<? extends java.lang.Exception> type)	Add a thrown Exception to this method's signature.
MethodSource<O>	addThrows(java.lang.String type)	Add a thrown Exception to this method's signature.
java.util.List<ParameterSource<O>>	getParameters()	Get a list of this Method's parameters.
MethodSource<O>	removeParameter(java.lang.Class<?> type, java.lang.String name)	Remove a parameter with the specified Class type and name from this method
MethodSource<O>	removeParameter(java.lang.String type, java.lang.String name)	Remove a parameter with the specified type and name from this method
MethodSource<O>	removeParameter(JavaType<?> type, java.lang.String name)	Remove a parameter with the specified JavaType type and name to this method
MethodSource<O>	removeParameter(ParameterSource<O> parameter)	Remove a parameter from this method
MethodSource<O>	removeThrows(java.lang.Class<? extends java.lang.Exception> type)	Remove a thrown Exception to this method's signature.
MethodSource<O>	removeThrows(java.lang.String type)	Remove a thrown Exception to this method's signature.
MethodSource<O>	setBody(java.lang.String body)	Set the inner body of this Method
MethodSource<O>	setConstructor(boolean constructor)	Toggle this method as a constructor.
MethodSource<O>	setDefault(boolean value)	Sets the default keyword in this method
MethodSource<O>	setNative(boolean value)	Sets this method to be native IMPORTANT: Setting it to true will remove the method body.
MethodSource<O>	setParameters(java.lang.String string)	Set this Method's parameters.
MethodSource<O>	setReturnType(java.lang.Class<?> type)	Set this Method to return the given type.
MethodSource<O>	setReturnType(java.lang.String type)	Set this Method to return the given type.
MethodSource<O>	setReturnType(JavaType<?> type)	Set this Method to return the given type.
MethodSource<O>	setReturnType(Type<?> type)	Set this Method to return the given type.
MethodSource<O>	setReturnTypeVoid()	Set this Method to return 'void'
MethodSource<O>	setSynchronized(boolean value)	Sets the synchronized keyword in this element.

Methods inherited from interface org.jboss.forge.roaster.model.Abstractable

isAbstract

Methods inherited from interface org.jboss.forge.roaster.model.source.AbstractableSource

setAbstract

Methods inherited from interface org.jboss.forge.roaster.model.AnnotationTarget

hasAnnotation, hasAnnotation

Methods inherited from interface org.jboss.forge.roaster.model.source.AnnotationTargetSource

addAnnotation, addAnnotation, addAnnotation, getAnnotation, getAnnotation, getAnnotations, removeAllAnnotations, removeAnnotation

Methods inherited from interface org.jboss.forge.roaster.model.FinalCapable

isFinal

Methods inherited from interface org.jboss.forge.roaster.model.source.FinalCapableSource

setFinal

Methods inherited from interface org.jboss.forge.roaster.model.GenericCapable

hasTypeVariable

Methods inherited from interface org.jboss.forge.roaster.model.source.GenericCapableSource

addTypeVariable, addTypeVariable, getTypeVariable, getTypeVariables, removeTypeVariable, removeTypeVariable

Methods inherited from interface org.jboss.forge.roaster.Internal

getInternal

Methods inherited from interface org.jboss.forge.roaster.model.JavaDocCapable

hasJavaDoc

Methods inherited from interface org.jboss.forge.roaster.model.source.JavaDocCapableSource

getJavaDoc, removeJavaDoc

Methods inherited from interface org.jboss.forge.roaster.model.source.LocationCapable

getColumnNumber, getEndPosition, getLineNumber, getStartPosition

Methods inherited from interface org.jboss.forge.roaster.model.Method

getBody, getReturnType, getThrownExceptions, isConstructor, isDefault, isNative, isReturnTypeVoid, isSynchronized, toSignature

Methods inherited from interface org.jboss.forge.roaster.model.Named

getName

Methods inherited from interface org.jboss.forge.roaster.model.source.NamedSource

setName

Methods inherited from interface org.jboss.forge.roaster.Origin

getOrigin

Methods inherited from interface org.jboss.forge.roaster.model.StaticCapable

isStatic

Methods inherited from interface org.jboss.forge.roaster.model.source.StaticCapableSource

setStatic

Methods inherited from interface org.jboss.forge.roaster.model.VisibilityScoped

getVisibility, isPackagePrivate, isPrivate, isProtected, isPublic

Methods inherited from interface org.jboss.forge.roaster.model.source.VisibilityScopedSource

setPackagePrivate, setPrivate, setProtected, setPublic, setVisibility

Method Detail

setDefault

MethodSource<O> setDefault(boolean value)

Sets the default keyword in this method

Parameters:

value - if this method should have the default keywork set

Returns:

the generic element this interface is bound to

setSynchronized

MethodSource<O> setSynchronized(boolean value)

Sets the synchronized keyword in this element.

Parameters:

value - if this element should be set to synchronized

Returns:

the generic element this interface is bound to

setNative

MethodSource<O> setNative(boolean value)

Sets this method to be native IMPORTANT: Setting it to true will remove the method body.

setReturnType

MethodSource<O> setReturnType(java.lang.Class<?> type)

Set this Method to return the given type. The type is properly imported if possible.

Parameters:

type - the return type

Returns:

this

See Also:

Importer.addImport(String)

setReturnType

MethodSource<O> setReturnType(java.lang.String type)

Set this Method to return the given type. The type is properly imported if possible.

Parameters:

type - the return type

Returns:

this

See Also:

Importer.addImport(String)

setReturnType

MethodSource<O> setReturnType(JavaType<?> type)

Set this Method to return the given type. The type is properly imported if possible.

Parameters:

type - the return type

Returns:

this

See Also:

Importer.addImport(String)

setReturnType

MethodSource<O> setReturnType(Type<?> type)

Set this Method to return the given type. The type is properly imported if possible.

Parameters:

type - the return type

Returns:

this

See Also:

Importer.addImport(String)

setReturnTypeVoid

MethodSource<O> setReturnTypeVoid()

Set this Method to return 'void'

setBody

MethodSource<O> setBody(java.lang.String body)

Set the inner body of this Method

setConstructor

MethodSource<O> setConstructor(boolean constructor)

Toggle this method as a constructor. If true, and the name of the Method is not the same as the name of its parent JavaClass , update the name of the method to match.

setParameters

MethodSource<O> setParameters(java.lang.String string)

Set this Method's parameters.

addThrows

MethodSource<O> addThrows(java.lang.String type)

Add a thrown Exception to this method's signature.

addThrows

MethodSource<O> addThrows(java.lang.Class<? extends java.lang.Exception> type)

Add a thrown Exception to this method's signature.

removeThrows

MethodSource<O> removeThrows(java.lang.String type)

Remove a thrown Exception to this method's signature.

removeThrows

MethodSource<O> removeThrows(java.lang.Class<? extends java.lang.Exception> type)

Remove a thrown Exception to this method's signature.

getParameters

java.util.List<ParameterSource<O>> getParameters()

Get a list of this Method's parameters.

Specified by:

getParameters in interface Method<O extends JavaSource<O>,MethodSource<O extends JavaSource<O>>>

addParameter

ParameterSource<O> addParameter(java.lang.Class<?> type,
                                java.lang.String name)

Add a parameter with the specified Class type and name to this method

addParameter

ParameterSource<O> addParameter(java.lang.String type,
                                java.lang.String name)

Add a parameter with the specified type and name to this method

addParameter

ParameterSource<O> addParameter(JavaType<?> type,
                                java.lang.String name)

Add a parameter with the specified JavaType type and name to this method

removeParameter

MethodSource<O> removeParameter(ParameterSource<O> parameter)

Remove a parameter from this method

removeParameter

MethodSource<O> removeParameter(java.lang.Class<?> type,
                                java.lang.String name)

Remove a parameter with the specified Class type and name from this method

removeParameter

MethodSource<O> removeParameter(java.lang.String type,
                                java.lang.String name)

Remove a parameter with the specified type and name from this method

removeParameter

MethodSource<O> removeParameter(JavaType<?> type,
                                java.lang.String name)

Remove a parameter with the specified JavaType type and name to this method