org.eclipse.xtend.lib.macro.declaration

Interface MutableExecutableDeclaration

All Superinterfaces:

AnnotationTarget, Declaration, Element, ExecutableDeclaration, MemberDeclaration, MutableAnnotationTarget, MutableDeclaration, MutableElement, MutableMemberDeclaration, MutableNamedElement, MutableTypeParameterDeclarator, NamedElement, TypeParameterDeclarator

All Known Subinterfaces:

MutableConstructorDeclaration, MutableMethodDeclaration

@Beta
public interface MutableExecutableDeclaration
extends MutableTypeParameterDeclarator, ExecutableDeclaration

Author:

Sven Efftinge

This interface is not intended to be implemented by clients.

This interface is not intended to be implemented by clients.

Method Summary

Methods

Modifier and Type	Method and Description
MutableParameterDeclaration	addParameter(java.lang.String name, TypeReference type) Adds a parameter
java.lang.Iterable<? extends MutableParameterDeclaration>	getParameters()
void	setBody(CompilationStrategy compilationStrategy) Sets the given CompilationStrategy as the body.
void	setBody(Expression body) Setting an expression will alter the scope of it accordingly.
void	setBody(StringConcatenationClient compilationTemplate) Sets the given StringConcatenationClient as the body.
void	setExceptions(TypeReference... exceptions) Sets the declared exceptions.
void	setVarArgs(boolean isVarArgs)

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableTypeParameterDeclarator

addTypeParameter, getTypeParameters

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableMemberDeclaration

getDeclaringType, setDeprecated, setDocComment, setVisibility

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableDeclaration

markAsRead

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableAnnotationTarget

addAnnotation, removeAnnotation

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableNamedElement

setSimpleName

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MutableElement

remove

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.ExecutableDeclaration

getBody, getExceptions, isVarArgs

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.MemberDeclaration

getDocComment, getModifiers, getVisibility, isDeprecated

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.AnnotationTarget

findAnnotation, getAnnotations

Methods inherited from interface org.eclipse.xtend.lib.macro.declaration.NamedElement

getCompilationUnit, getSimpleName

Method Detail

getParameters

java.lang.Iterable<? extends MutableParameterDeclaration> getParameters()

Specified by:

getParameters in interface ExecutableDeclaration

Returns:

the declared parameters

setVarArgs

void setVarArgs(boolean isVarArgs)

Parameters:

isVarArgs - whether the last argument is a var arg.

setBody

void setBody(Expression body)

Setting an expression will alter the scope of it accordingly. Each expression can only be assigned to one element, if this MutableExecutableDeclaration has already set another expression or compilation strategy the old one will be detached. If the given expression is already assigned to another MutableExecutableDeclaration or MutableFieldDeclaration it will be automatically detached from it.

Parameters:

body - the expression to set as the body of this executable

setBody

void setBody(CompilationStrategy compilationStrategy)

Sets the given CompilationStrategy as the body. The given CompilationStrategy will be executed later during code generation, not immediately. If this MutableExecutableDeclaration has already set another expression or compilation strategy the old one will be detached.

Parameters:

compilationStrategy - the compilation strategy, must not be null

Throws:

java.lang.IllegalArgumentException - if compilationStrategy is null

setBody

void setBody(StringConcatenationClient compilationTemplate)

Sets the given StringConcatenationClient as the body. The given StringConcatenationClient will be executed later during code generation, not immediately. If this MutableExecutableDeclaration has already set another expression or compilation strategy the old one will be detached.

Parameters:

compilationTemplate - the compilation strategy, must not be null

Throws:

java.lang.IllegalArgumentException - if compilationStrategy is null

setExceptions

void setExceptions(TypeReference... exceptions)

Sets the declared exceptions.

Parameters:

exceptions - the declared exceptions

Throws:

java.lang.IllegalArgumentException - if the exceptions is null or contains null

addParameter

MutableParameterDeclaration addParameter(java.lang.String name,
                                       TypeReference type)

Adds a parameter

Parameters:

name - the name of the parameter, must be a valid java identifier

type - the type of the parameter, must not be null

Returns:

the created parameter

Throws:

java.lang.IllegalArgumentException - if the name is not a valid java identifier or the type is null