Interface CodeField

All Superinterfaces:

CodeAdvancedMergeableItem<CodeField>, CodeElement, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeExpression, CodeItem, CodeItemWithComment, CodeItemWithDeclaration, CodeItemWithDeclaringType, CodeItemWithModifiers, CodeItemWithName, CodeItemWithType, CodeMember, CodeMergeableItem<CodeField>, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeMutableItemWithType, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeFields, CodeField>, CodeVariable, CodeWithContext

public interface CodeField
extends CodeMember, CodeMutableItemWithType, CodeVariable, CodeAdvancedMergeableItem<CodeField>, CodeNodeItemCopyable<CodeFields, CodeField>

CodeMember for a field of a CodeType.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

• Field
• CodeType.getFields()
• CodeNodeContainer.getDeclared()

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeField	copy()
CodeMethod	getGetter()
CodeExpression	getInitializer()
CodeMethod	getOrCreateGetter()
CodeMethod	getOrCreateSetter()
Field	getReflectiveObject()
CodeMethod	getSetter()
void	setInitializer(CodeExpression initializer)

Methods inherited from interface CodeAdvancedMergeableItem

merge, merge, merge

Methods inherited from interface CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface CodeElementWithModifiers

setModifiers

Methods inherited from interface CodeElementWithName

setName

Methods inherited from interface CodeExpression

evaluate

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeItemWithDeclaration

writeReference

Methods inherited from interface CodeItemWithDeclaringType

getDeclaringType

Methods inherited from interface CodeItemWithModifiers

getModifiers

Methods inherited from interface CodeItemWithName

getName

Methods inherited from interface CodeItemWithType

getType

Methods inherited from interface CodeMember

getParent

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

setImmutable

Methods inherited from interface CodeMutableItemWithComment

setComment

Methods inherited from interface CodeMutableItemWithType

setType

Methods inherited from interface CodeNodeItemCopyable

copy, getParent

Methods inherited from interface CodeVariable

writeReference

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getInitializer

CodeExpression getInitializer()

Returns:

the CodeExpression assigned to this field on initialization or null for none.

setInitializer

void setInitializer(CodeExpression initializer)

Parameters:

initializer - the new initializer.

Throws:

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

getReflectiveObject

Field getReflectiveObject()

Specified by:

getReflectiveObject in interface CodeMember

Specified by:

getReflectiveObject in interface CodeMutableItem

Returns:

the optional reflective object of this item such as Class. May be null (e.g. if this object was created from source-code only or has been created dynamically). However, if available it can be helpful for analysis especially in case of type-safe Annotation processing. In most cases the generic type will be derived from AnnotatedElement but in specific cases it can also be ProtectionDomain or other types that have no common parent-type. Therefore this generic type is unbounded here.

See Also:

• Member

getGetter

CodeMethod getGetter()

Returns:

the CodeMethod that acts as getter to read this field or null if there is no such method.

getOrCreateGetter

CodeMethod getOrCreateGetter()

Returns:

the CodeMethod that acts as getter to read this field. If it does not yet exist, it will be created.

getSetter

CodeMethod getSetter()

Returns:

the CodeMethod that acts as setter to write this field or null if there is no such method.

getOrCreateSetter

CodeMethod getOrCreateSetter()

Returns:

the CodeMethod that acts as setter to write this field. If it does not yet exist, it will be created.

copy

CodeField copy()

Specified by:

copy in interface CodeElement

Specified by:

copy in interface CodeElementWithDeclaringType

Specified by:

copy in interface CodeElementWithModifiers

Specified by:

copy in interface CodeElementWithName

Specified by:

copy in interface CodeMember

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeFields, CodeField>

Returns:

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