Interface CodeNodeItemContainerWithName<I extends CodeItem>

Type Parameters:

I - the type of the contained CodeItems.

All Superinterfaces:

CodeItem, CodeMutable, CodeMutableItem, CodeNode, CodeNodeContainer<I>, CodeNodeItem, CodeNodeItemContainer<I>, CodeWithContext, Iterable<I>

All Known Subinterfaces:

CodeFields, CodeNestedTypes, CodeNodeItemContainerFlatWithName<I>, CodeNodeItemContainerHierarchicalWithName<I>, CodeParameters, CodeProperties, CodeTypeVariables

public interface CodeNodeItemContainerWithName<I extends CodeItem>
extends CodeNodeItemContainer<I>

CodeNodeItemContainer containing named CodeItems.

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
I	add(String name)
CodeNodeItemContainerWithName<I>	copy()
I	get(String name)
I	getDeclared(String name)
default I	getDeclaredOrCreate(String name)
default I	getOrCreate(String name)
default I	getRequired(String name)

Methods inherited from interface CodeItem

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

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, getParent, remove

Methods inherited from interface CodeWithContext

getContext, getSource

Methods inherited from interface Iterable

forEach, spliterator

Method Details

get

I get(String name)

Parameters:

name - the name of the requested CodeItem.

Returns:

the CodeItem from all items with the given name or null if no such item exists.

getRequired

default I getRequired(String name)

Parameters:

name - the name of the requested CodeItem.

Returns:

the CodeItem from all items with the given name.

Throws:

io.github.mmm.base.exception.ObjectNotFoundException - if the requested item was not found.

getOrCreate

default I getOrCreate(String name)

Parameters:

name - the name of the requested CodeItem.

Returns:

the existing or added CodeItem.

getDeclared

I getDeclared(String name)

Parameters:

name - the name of the requested CodeItem.

Returns:

the CodeItem from the declared items with the given name or null if no such item exists.

getDeclaredOrCreate

default I getDeclaredOrCreate(String name)

Parameters:

name - the name of the requested CodeItem.

Returns:

the existing or added CodeItem.

add

I add(String name)

Parameters:

name - the name of the CodeItemWithName to create.

Returns:

a new CodeItem that has been added.

Throws:

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

copy

CodeNodeItemContainerWithName<I> copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemContainer<I extends CodeItem>

Returns:

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