Class BaseNodeItem

java.lang.Object

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

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

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

All Implemented Interfaces:

io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable

Direct Known Subclasses:

BaseAnnotation, BaseBlock, BaseDoc, BaseElement, BaseNodeItemContainer

public abstract class BaseNodeItem
extends BaseMutableItem
implements io.github.mmm.code.api.node.CodeNodeItem

Base implementation of CodeNodeItem.

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
BaseNodeItem()	The constructor.
BaseNodeItem(BaseNodeItem template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doInitialize()	Called from BaseMutableItem.initialize() on first invocation.
protected static <I extends io.github.mmm.code.api.item.CodeItem> I	getContainerItem(BaseNodeItemContainerWithName<I> container, String name, boolean init)
protected static <I extends io.github.mmm.code.api.item.CodeItem> I	getContainerItemDeclared(BaseNodeItemContainerWithName<I> container, String name, boolean init)
BaseContext	getContext()
io.github.mmm.code.api.language.CodeLanguage	getLanguage()
BaseSource	getSource()
String	toPathString()

Methods inherited from class BaseMutableItem

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

Methods inherited from class BaseItem

doWrite, 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.item.CodeItem

getSourceCode, write, write, write, write, write, write

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

isImmutable, isMutable

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

getReflectiveObject, setImmutable

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

getParent

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

copy, copy

Constructor Details

BaseNodeItem

public BaseNodeItem()

The constructor.

BaseNodeItem

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

The copy-constructor.

Parameters:

template - the BaseNodeItem to copy.

mapper - the CodeCopyMapper.

Method Details

doInitialize

protected void doInitialize()

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

Overrides:

doInitialize in class BaseMutableItem

getContext

public BaseContext getContext()

Specified by:

getContext in interface io.github.mmm.code.api.CodeWithContext

getSource

public BaseSource getSource()

Specified by:

getSource in interface io.github.mmm.code.api.CodeWithContext

getLanguage

public io.github.mmm.code.api.language.CodeLanguage getLanguage()

Specified by:

getLanguage in interface io.github.mmm.code.api.item.CodeItem

toPathString

public String toPathString()

Returns:

a String representation of the entire node tree to this node.

getContainerItem

protected static <I extends io.github.mmm.code.api.item.CodeItem>
I getContainerItem(BaseNodeItemContainerWithName<I> container,
 String name,
 boolean init)

Type Parameters:

I - type of the CodeItem.

Parameters:

container - the BaseNodeItemContainerWithName.

name - - see BaseNodeItemContainerWithName.get(String, boolean).

init - - see BaseNodeItemContainerWithName.get(String, boolean).

Returns:

see BaseNodeItemContainerWithName.get(String, boolean).

getContainerItemDeclared

protected static <I extends io.github.mmm.code.api.item.CodeItem>
I getContainerItemDeclared(BaseNodeItemContainerWithName<I> container,
 String name,
 boolean init)

Type Parameters:

I - type of the CodeItem.

Parameters:

container - the BaseNodeItemContainerWithName.

name - - see BaseNodeItemContainerWithName.getDeclared(String, boolean).

init - - see BaseNodeItemContainerWithName.getDeclared(String, boolean).

Returns:

see BaseNodeItemContainerWithName.getDeclared(String, boolean).