Interface CodeMethod

All Superinterfaces:

CodeAdvancedMergeableItem<CodeMethod>, CodeElement, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeElementWithTypeVariables, CodeFunction, CodeItem, CodeItemWithComment, CodeItemWithDeclaringType, CodeItemWithModifiers, CodeItemWithName, CodeItemWithType, CodeItemWithVariables, CodeMember, CodeMergeableItem<CodeMethod>, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeMethods, CodeMethod>, CodeOperation, CodeWithContext

public interface CodeMethod
extends CodeOperation, CodeAdvancedMergeableItem<CodeMethod>, CodeNodeItemCopyable<CodeMethods, CodeMethod>

CodeOperation that represents a method of a CodeType.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

• CodeType.getMethods()
• CodeNodeContainer.getDeclared()
• Method

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeMethod	copy()
CodeField	getAccessorField()
CodeExpression	getDefaultValue()
CodeMethod	getParentMethod()	Attention: This method is expensive as it has to traverse all methods of the entire type hierarchy recursively.
Method	getReflectiveObject()
CodeReturn	getReturns()
default CodeGenericType	getType()
void	setDefaultValue(CodeExpression defaultValue)

Methods inherited from interface CodeAdvancedMergeableItem

merge, merge, merge

Methods inherited from interface CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface CodeElementWithModifiers

setModifiers

Methods inherited from interface CodeElementWithName

setName

Methods inherited from interface CodeElementWithTypeVariables

getTypeParameters

Methods inherited from interface CodeFunction

canHaveBody, getBody, setBody

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeItemWithDeclaringType

getDeclaringType

Methods inherited from interface CodeItemWithModifiers

getModifiers

Methods inherited from interface CodeItemWithName

getName

Methods inherited from interface CodeItemWithVariables

getVariable

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

setImmutable

Methods inherited from interface CodeMutableItemWithComment

setComment

Methods inherited from interface CodeNodeItemCopyable

copy, getParent

Methods inherited from interface CodeOperation

getExceptions, getParameters, getParent

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getType

default CodeGenericType getType()

Specified by:

getType in interface CodeItemWithType

Returns:

the return type of this method.

getReturns

CodeReturn getReturns()

Returns:

the CodeReturn with the information about the returned result of this method. Will never be null. In case of a programming language that supports multiple return types a single CodeReturn will be returned that reflects a tuple of the actual returned types.

getDefaultValue

CodeExpression getDefaultValue()

Returns:

the default value of this method or null for none.

See Also:

• Method.getDefaultValue()

setDefaultValue

void setDefaultValue(CodeExpression defaultValue)

Parameters:

defaultValue - the new value of getDefaultValue().

getParentMethod

CodeMethod getParentMethod()

Attention:
This method is expensive as it has to traverse all methods of the entire type hierarchy recursively.

Returns:

the CodeMethod inherited from the closest super type that is overridden by this method or null if this method does not override any method. Here closest means that class hierarchy is searched first, then the interface hierarchy in left recursive order.

getAccessorField

CodeField getAccessorField()

Returns:

the CodeField that acts as a native property with this method as getter or setter. Will be null for a regular method.

getReflectiveObject

Method getReflectiveObject()

Specified by:

getReflectiveObject in interface CodeElementWithTypeVariables

Specified by:

getReflectiveObject in interface CodeMember

Specified by:

getReflectiveObject in interface CodeMutableItem

Specified by:

getReflectiveObject in interface CodeOperation

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.

See Also:

• Member

copy

CodeMethod copy()

Specified by:

copy in interface CodeElement

Specified by:

copy in interface CodeElementWithDeclaringType

Specified by:

copy in interface CodeElementWithModifiers

Specified by:

copy in interface CodeElementWithName

Specified by:

copy in interface CodeElementWithTypeVariables

Specified by:

copy in interface CodeMember

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeMethods, CodeMethod>

Specified by:

copy in interface CodeOperation

Returns:

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