Class BaseMethod

java.lang.Object

io.github.mmm.code.base.item.BaseItem

io.github.mmm.code.base.item.BaseMutableItem

io.github.mmm.code.base.node.BaseNodeItem

io.github.mmm.code.base.element.BaseElement

io.github.mmm.code.base.element.BaseElementWithDeclaringType

io.github.mmm.code.base.element.BaseElementWithModifiers

io.github.mmm.code.base.member.BaseMember

io.github.mmm.code.base.member.BaseOperation

io.github.mmm.code.base.member.BaseMethod

All Implemented Interfaces:

io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.member.CodeMethods, io.github.mmm.code.api.member.CodeMethod>, io.github.mmm.code.api.element.CodeElement, io.github.mmm.code.api.element.CodeElementWithDeclaringType, io.github.mmm.code.api.element.CodeElementWithModifiers, io.github.mmm.code.api.element.CodeElementWithName, io.github.mmm.code.api.element.CodeElementWithTypeVariables, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithComment, io.github.mmm.code.api.item.CodeItemWithDeclaringType, io.github.mmm.code.api.item.CodeItemWithModifiers, io.github.mmm.code.api.item.CodeItemWithName, io.github.mmm.code.api.item.CodeItemWithType, io.github.mmm.code.api.item.CodeItemWithVariables, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.item.CodeMutableItemWithComment, io.github.mmm.code.api.member.CodeMember, io.github.mmm.code.api.member.CodeMethod, io.github.mmm.code.api.member.CodeOperation, io.github.mmm.code.api.merge.CodeAdvancedMergeableItem<io.github.mmm.code.api.member.CodeMethod>, io.github.mmm.code.api.merge.CodeMergeableItem<io.github.mmm.code.api.member.CodeMethod>, io.github.mmm.code.api.node.CodeFunction, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable

public class BaseMethod
extends BaseOperation
implements io.github.mmm.code.api.member.CodeMethod

Base implementation of CodeMethod.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface io.github.mmm.code.api.item.CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Constructor Summary

Constructors

Constructor	Description
BaseMethod(BaseMethod template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.
BaseMethod(BaseMethods parent, Method reflectiveObject)	The constructor.
BaseMethod(BaseMethods parent, String name)	The constructor.
BaseMethod(BaseMethods parent, String name, BaseTypeVariables typeVariables)	The constructor.

Method Summary

Modifier and Type	Method	Description
boolean	canHaveBody()
BaseMethod	copy()
BaseMethod	copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)
protected void	doInitialize()	Called from BaseMutableItem.initialize() on first invocation.
protected void	doSetImmutable()	Called on the first call of BaseMutableItem.setImmutable().
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
io.github.mmm.code.api.member.CodeField	getAccessorField()
io.github.mmm.code.api.expression.CodeExpression	getDefaultValue()
BaseMethods	getParent()
io.github.mmm.code.api.member.CodeMethod	getParentMethod()
Method	getReflectiveObject()
BaseReturn	getReturns()
io.github.mmm.code.api.member.CodeMethod	getSourceCodeObject()
io.github.mmm.code.api.member.CodeMethod	merge(io.github.mmm.code.api.member.CodeMethod other, io.github.mmm.code.api.merge.CodeMergeStrategyDecider decider, io.github.mmm.code.api.merge.CodeMergeStrategy parentStrategy)
void	setDefaultValue(io.github.mmm.code.api.expression.CodeExpression defaultValue)

Methods inherited from class BaseOperation

doMerge, getBody, getExceptions, getParameters, getTypeParameters, getVariable, setBody

Methods inherited from class BaseMember

getDeclaringType, getName, setName

Methods inherited from class BaseElementWithModifiers

getModifiers, setModifiers

Methods inherited from class BaseElement

doMerge, doWriteAnnotations, doWriteComment, doWriteDoc, getAnnotations, getComment, getDoc, removeFromParent, setComment

Methods inherited from class BaseNodeItem

getContainerItem, getContainerItemDeclared, getContext, getLanguage, getSource, toPathString

Methods inherited from class BaseMutableItem

doCopyNode, doCopyNodeUnsafe, doMapList, doneInitialize, getDefaultCopyMapper, getDefaultEncoding, initialize, initialize, isImmutable, isInitialized, isInitializing, isSystemImmutable, isSystemImmutable, makeImmutable, makeImmutable, setImmutable, setImmutableIfNotSystemImmutable, verifyMutalbe, writeItem

Methods inherited from class BaseItem

getOwningType, getSourceCode, getSpaces, toString, write

Methods inherited from class Object

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

Methods inherited from interface io.github.mmm.code.api.merge.CodeAdvancedMergeableItem

merge, merge

Methods inherited from interface io.github.mmm.code.api.element.CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface io.github.mmm.code.api.element.CodeElementWithModifiers

setModifiers

Methods inherited from interface io.github.mmm.code.api.element.CodeElementWithName

setName

Methods inherited from interface io.github.mmm.code.api.element.CodeElementWithTypeVariables

getTypeParameters

Methods inherited from interface io.github.mmm.code.api.node.CodeFunction

getBody, setBody

Methods inherited from interface io.github.mmm.code.api.item.CodeItem

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

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithComment

getComment

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithDeclaringType

getDeclaringType

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithModifiers

getModifiers

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithName

getName

Methods inherited from interface io.github.mmm.code.api.item.CodeItemWithVariables

getVariable

Methods inherited from interface io.github.mmm.code.api.member.CodeMethod

getType

Methods inherited from interface io.github.mmm.code.api.object.CodeMutable

isImmutable, isMutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItem

setImmutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItemWithComment

setComment

Methods inherited from interface io.github.mmm.code.api.member.CodeOperation

getExceptions, getParameters

Methods inherited from interface io.github.mmm.code.api.CodeWithContext

getContext, getSource

Constructor Details

BaseMethod

public BaseMethod(BaseMethods parent,
 String name)

The constructor.

Parameters:

parent - the parent.

name - the name.

BaseMethod

public BaseMethod(BaseMethods parent,
 String name,
 BaseTypeVariables typeVariables)

The constructor.

Parameters:

parent - the parent.

name - the name.

typeVariables - the type variables.

BaseMethod

public BaseMethod(BaseMethods parent,
 Method reflectiveObject)

The constructor.

Parameters:

parent - the parent.

reflectiveObject - the reflective object. May be null.

BaseMethod

public BaseMethod(BaseMethod template,
 io.github.mmm.code.api.copy.CodeCopyMapper mapper)

The copy-constructor.

Parameters:

template - the BaseMethod to copy.

mapper - the CodeCopyMapper.

Method Details

doInitialize

protected void doInitialize()

Description copied from class: BaseNodeItem

Called from BaseMutableItem.initialize() on first invocation. May be overridden but never be called from anywhere else.

Overrides:

doInitialize in class BaseElement

getParent

public BaseMethods getParent()

Specified by:

getParent in interface io.github.mmm.code.api.member.CodeMember

Specified by:

getParent in interface io.github.mmm.code.api.node.CodeNode

Specified by:

getParent in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.member.CodeMethods, io.github.mmm.code.api.member.CodeMethod>

Specified by:

getParent in interface io.github.mmm.code.api.member.CodeOperation

Specified by:

getParent in class BaseOperation

doSetImmutable

protected void doSetImmutable()

Description copied from class: BaseMutableItem

Called on the first call of BaseMutableItem.setImmutable(). Has to be overridden to update Collections, make child items immutable, etc.

Overrides:

doSetImmutable in class BaseOperation

getReturns

public BaseReturn getReturns()

Specified by:

getReturns in interface io.github.mmm.code.api.member.CodeMethod

getDefaultValue

public io.github.mmm.code.api.expression.CodeExpression getDefaultValue()

Specified by:

getDefaultValue in interface io.github.mmm.code.api.member.CodeMethod

setDefaultValue

public void setDefaultValue(io.github.mmm.code.api.expression.CodeExpression defaultValue)

Specified by:

setDefaultValue in interface io.github.mmm.code.api.member.CodeMethod

getReflectiveObject

public Method getReflectiveObject()

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.element.CodeElementWithTypeVariables

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.member.CodeMember

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.member.CodeMethod

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.member.CodeOperation

Specified by:

getReflectiveObject in class BaseOperation

canHaveBody

public boolean canHaveBody()

Specified by:

canHaveBody in interface io.github.mmm.code.api.node.CodeFunction

Overrides:

canHaveBody in class BaseOperation

getSourceCodeObject

public io.github.mmm.code.api.member.CodeMethod getSourceCodeObject()

Specified by:

getSourceCodeObject in class BaseOperation

Returns:

the optional internal CodeItem representing the source-code (to merge). Otherwise null. This is an internal API. Do not use or rely on it from outside.

getParentMethod

public io.github.mmm.code.api.member.CodeMethod getParentMethod()

Specified by:

getParentMethod in interface io.github.mmm.code.api.member.CodeMethod

getAccessorField

public io.github.mmm.code.api.member.CodeField getAccessorField()

Specified by:

getAccessorField in interface io.github.mmm.code.api.member.CodeMethod

merge

public io.github.mmm.code.api.member.CodeMethod merge(io.github.mmm.code.api.member.CodeMethod other,
 io.github.mmm.code.api.merge.CodeMergeStrategyDecider decider,
 io.github.mmm.code.api.merge.CodeMergeStrategy parentStrategy)

Specified by:

merge in interface io.github.mmm.code.api.merge.CodeAdvancedMergeableItem<io.github.mmm.code.api.member.CodeMethod>

copy

public BaseMethod copy()

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElement

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElementWithDeclaringType

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElementWithModifiers

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElementWithName

Specified by:

copy in interface io.github.mmm.code.api.element.CodeElementWithTypeVariables

Specified by:

copy in interface io.github.mmm.code.api.member.CodeMember

Specified by:

copy in interface io.github.mmm.code.api.member.CodeMethod

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.member.CodeMethods, io.github.mmm.code.api.member.CodeMethod>

Specified by:

copy in interface io.github.mmm.code.api.member.CodeOperation

Specified by:

copy in class BaseOperation

copy

public BaseMethod copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.member.CodeMethods, io.github.mmm.code.api.member.CodeMethod>

doWrite

protected void doWrite(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 io.github.mmm.code.api.language.CodeLanguage language)
                throws IOException

Overrides:

doWrite in class BaseElement

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

Throws:

IOException - if thrown by Appendable.

See Also:

• CodeItem.write(Appendable, String, String)