Interface CodeParameter

All Superinterfaces:

CodeElement, CodeElementWithDeclaringType, CodeElementWithName, CodeExpression, CodeItem, CodeItemWithComment, CodeItemWithDeclaration, CodeItemWithDeclaringType, CodeItemWithName, CodeItemWithType, CodeMergeableItem<CodeParameter>, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeMutableItemWithType, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeParameters, CodeParameter>, CodeNodeItemWithDeclaringOperation, CodeOperationArg, CodeSimpleMergeableItem<CodeParameter>, CodeVariable, CodeWithContext

public interface CodeParameter
extends CodeOperationArg, CodeElementWithName, CodeVariable, CodeSimpleMergeableItem<CodeParameter>, CodeNodeItemCopyable<CodeParameters, CodeParameter>

CodeOperationArg for a parameter (argument) of a CodeOperation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

• CodeOperation.getParameters()

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeParameter	copy()
Parameter	getReflectiveObject()
boolean	isVarArgs()
void	setVarArgs(boolean varArgs)

Methods inherited from interface CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface CodeElementWithName

setName

Methods inherited from interface CodeExpression

evaluate

Methods inherited from interface CodeItem

getLanguage, getSourceCode, write, write, write, write, write, write

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeItemWithDeclaration

writeReference

Methods inherited from interface CodeItemWithDeclaringType

getDeclaringType

Methods inherited from interface CodeItemWithName

getName

Methods inherited from interface CodeItemWithType

getType

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

setImmutable

Methods inherited from interface CodeMutableItemWithComment

setComment

Methods inherited from interface CodeMutableItemWithType

setType

Methods inherited from interface CodeNodeItemCopyable

copy, getParent

Methods inherited from interface CodeNodeItemWithDeclaringOperation

getDeclaringOperation

Methods inherited from interface CodeSimpleMergeableItem

merge, merge

Methods inherited from interface CodeVariable

writeReference

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

isVarArgs

boolean isVarArgs()

Returns:

true in case of a var-arg parameter (e.g. {String...), false otherwise. If a var-arg parameter this has to be the last parameter in the signature and the type has to be an array. For invocations this parameter can take any number of actual arguments of the type's component-type including none. These parameters will technically be converted to an array passed for this parameter.

See Also:

• Parameter.isVarArgs()

setVarArgs

void setVarArgs(boolean varArgs)

Parameters:

varArgs - the new value for isVarArgs().

Throws:

io.github.mmm.base.exception.ReadOnlyException - if immutable.

getReflectiveObject

Parameter getReflectiveObject()

Specified by:

getReflectiveObject in interface CodeMutableItem

Returns:

the optional reflective object of this item such as Class. May be null (e.g. if this object was created from source-code only or has been created dynamically). However, if available it can be helpful for analysis especially in case of type-safe Annotation processing. In most cases the generic type will be derived from AnnotatedElement but in specific cases it can also be ProtectionDomain or other types that have no common parent-type. Therefore this generic type is unbounded here.

copy

CodeParameter copy()

Specified by:

copy in interface CodeElement

Specified by:

copy in interface CodeElementWithDeclaringType

Specified by:

copy in interface CodeElementWithName

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeParameters, CodeParameter>

Returns:

a new mutable copy of this CodeMutableItem. Will be a deep-copy with copies of all child CodeMutableItems.