Interface CodeMethods

All Superinterfaces:

CodeAdvancedMergeableItem<CodeMethods>, CodeItem, CodeItemWithDeclaringType, CodeMembers<CodeMethod>, CodeMergeableItem<CodeMethods>, CodeMutable, CodeMutableItem, CodeNode, CodeNodeContainer<CodeMethod>, CodeNodeItem, CodeNodeItemContainer<CodeMethod>, CodeNodeItemContainerHierarchical<CodeMethod>, CodeNodeItemCopyable<CodeType, CodeMethods>, CodeOperations<CodeMethod>, CodeWithContext, Iterable<CodeMethod>

public interface CodeMethods
extends CodeOperations<CodeMethod>, CodeNodeItemContainerHierarchical<CodeMethod>, CodeAdvancedMergeableItem<CodeMethods>, CodeNodeItemCopyable<CodeType, CodeMethods>

CodeMembers as a container for the CodeMethods.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeMethod	add(String name)
CodeMethods	copy()
CodeMethod	getDeclared(String name, CodeGenericType... parameterTypes)
default CodeMethod	getFirst(String name)
default CodeMethod	getFirstOrCreate(String name)

Methods inherited from interface CodeAdvancedMergeableItem

merge, merge, merge

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithDeclaringType

getDeclaringType

Methods inherited from interface CodeMembers

add, getParent

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeNodeContainer

getDeclared, isEmpty, iterator

Methods inherited from interface CodeNodeItemContainer

copy, remove

Methods inherited from interface CodeNodeItemContainerHierarchical

getAll

Methods inherited from interface CodeNodeItemCopyable

copy, getParent

Methods inherited from interface CodeOperations

get

Methods inherited from interface CodeWithContext

getContext, getSource

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getDeclared

CodeMethod getDeclared(String name,
 CodeGenericType... parameterTypes)

Parameters:

name - the name of the requested CodeOperation.

parameterTypes - the CodeGenericTypes of the parameters.

Returns:

the requested CodeOperation or null if not found.

add

CodeMethod add(String name)

Parameters:

name - the method name.

Returns:

a new CodeMethod that has been added to CodeNodeContainer.getDeclared(). The return type will be initialized as void. It will not have any parameters or exceptions. Simply add those afterwards as needed.

Throws:

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

getFirst

default CodeMethod getFirst(String name)

Parameters:

name - the method name.

Returns:

the first CodeMethod with the given name that has been found or null if no such method exists. Please note that languages such as Java can have many methods with the same name. In such case it is unspecified which of these methods is returned. However, for convenience this method can be handy to find getters, setters, hashCode, etc.

getFirstOrCreate

default CodeMethod getFirstOrCreate(String name)

Parameters:

name - the method name.

Returns:

the first CodeMethod with the given name that has been found or a newly added one if no such method exists. Please note that languages such as Java can have many methods with the same name. In such case it is unspecified which of these methods is returned.

copy

CodeMethods copy()

Specified by:

copy in interface CodeMembers<CodeMethod>

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemContainer<CodeMethod>

Specified by:

copy in interface CodeNodeItemContainerHierarchical<CodeMethod>

Specified by:

copy in interface CodeNodeItemCopyable<CodeType, CodeMethods>

Specified by:

copy in interface CodeOperations<CodeMethod>

Returns:

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