Class BaseField

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.BaseField

All Implemented Interfaces:

io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.member.CodeFields, io.github.mmm.code.api.member.CodeField>, 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.expression.CodeExpression, io.github.mmm.code.api.expression.CodeVariable, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithComment, io.github.mmm.code.api.item.CodeItemWithDeclaration, 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.CodeMutableItem, io.github.mmm.code.api.item.CodeMutableItemWithComment, io.github.mmm.code.api.item.CodeMutableItemWithType, io.github.mmm.code.api.member.CodeField, io.github.mmm.code.api.member.CodeMember, io.github.mmm.code.api.merge.CodeAdvancedMergeableItem<io.github.mmm.code.api.member.CodeField>, io.github.mmm.code.api.merge.CodeMergeableItem<io.github.mmm.code.api.member.CodeField>, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable

public class BaseField
extends BaseMember
implements io.github.mmm.code.api.member.CodeField

Base implementation of CodeField.

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
BaseField(BaseField template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.
BaseField(BaseFields parent, Field reflectiveObject)	The constructor.
BaseField(BaseFields parent, String name)	The constructor.

Method Summary

Modifier and Type	Method	Description
BaseField	copy()
BaseField	copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)
protected void	doInitialize()	Called from BaseMutableItem.initialize() on first invocation.
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
io.github.mmm.code.api.expression.CodeConstant	evaluate()
io.github.mmm.code.api.member.CodeMethod	getGetter()
io.github.mmm.code.api.expression.CodeExpression	getInitializer()
io.github.mmm.code.api.member.CodeMethod	getOrCreateGetter()
io.github.mmm.code.api.member.CodeMethod	getOrCreateSetter()
BaseFields	getParent()
Field	getReflectiveObject()
io.github.mmm.code.api.member.CodeMethod	getSetter()
io.github.mmm.code.api.member.CodeField	getSourceCodeObject()
io.github.mmm.code.api.type.CodeGenericType	getType()
io.github.mmm.code.api.member.CodeField	merge(io.github.mmm.code.api.member.CodeField other, io.github.mmm.code.api.merge.CodeMergeStrategyDecider decider, io.github.mmm.code.api.merge.CodeMergeStrategy parentStrategy)
void	setInitializer(io.github.mmm.code.api.expression.CodeExpression initializer)
void	setType(io.github.mmm.code.api.type.CodeGenericType type)

Methods inherited from class BaseMember

getDeclaringType, getName, setName

Methods inherited from class BaseElementWithModifiers

getModifiers, setModifiers

Methods inherited from class BaseElement

doMerge, doSetImmutable, 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.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.CodeItemWithDeclaration

writeReference

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.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.expression.CodeVariable

writeReference

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

getContext, getSource

Constructor Details

BaseField

public BaseField(BaseFields parent,
 String name)

The constructor.

Parameters:

parent - the parent.

name - the name.

BaseField

public BaseField(BaseFields parent,
 Field reflectiveObject)

The constructor.

Parameters:

parent - the parent.

reflectiveObject - the reflective object. May be null.

BaseField

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

The copy-constructor.

Parameters:

template - the BaseField 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 BaseFields 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.CodeFields, io.github.mmm.code.api.member.CodeField>

Specified by:

getParent in class BaseMember

getType

public io.github.mmm.code.api.type.CodeGenericType getType()

Specified by:

getType in interface io.github.mmm.code.api.item.CodeItemWithType

setType

public void setType(io.github.mmm.code.api.type.CodeGenericType type)

Specified by:

setType in interface io.github.mmm.code.api.item.CodeMutableItemWithType

getInitializer

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

Specified by:

getInitializer in interface io.github.mmm.code.api.member.CodeField

setInitializer

public void setInitializer(io.github.mmm.code.api.expression.CodeExpression initializer)

Specified by:

setInitializer in interface io.github.mmm.code.api.member.CodeField

evaluate

public io.github.mmm.code.api.expression.CodeConstant evaluate()

Specified by:

evaluate in interface io.github.mmm.code.api.expression.CodeExpression

getReflectiveObject

public Field getReflectiveObject()

Specified by:

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

Specified by:

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

Specified by:

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

Specified by:

getReflectiveObject in class BaseMember

getSourceCodeObject

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

Specified by:

getSourceCodeObject in class BaseMember

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.

merge

public io.github.mmm.code.api.member.CodeField merge(io.github.mmm.code.api.member.CodeField 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.CodeField>

copy

public BaseField 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.member.CodeField

Specified by:

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

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.CodeFields, io.github.mmm.code.api.member.CodeField>

Specified by:

copy in class BaseMember

copy

public BaseField 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.CodeFields, io.github.mmm.code.api.member.CodeField>

getGetter

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

Specified by:

getGetter in interface io.github.mmm.code.api.member.CodeField

getOrCreateGetter

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

Specified by:

getOrCreateGetter in interface io.github.mmm.code.api.member.CodeField

getSetter

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

Specified by:

getSetter in interface io.github.mmm.code.api.member.CodeField

getOrCreateSetter

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

Specified by:

getOrCreateSetter in interface io.github.mmm.code.api.member.CodeField

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)