Interface CodeProperty

All Superinterfaces:

CodeElement, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeItem, CodeItemWithComment, CodeItemWithDeclaringType, CodeItemWithModifiers, CodeItemWithName, CodeItemWithType, CodeMember, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeMutableItemWithType, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeProperties, CodeProperty>, CodeWithContext

public interface CodeProperty
extends CodeMember, CodeMutableItemWithType, CodeNodeItemCopyable<CodeProperties, CodeProperty>

Abstract interface for a field of a CodeType.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

• CodeType.getProperties()

Field Summary

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeProperty	copy()
CodeField	getField()
CodeMethod	getGetter()
CodeMethod	getSetter()
CodeProperty	inherit(CodeType declaring)
default boolean	isPrivateReadable()
default boolean	isPrivateWritable()
default boolean	isPublicReadable()
default boolean	isPublicWritable()
boolean	isReadable(CodeVisibility visibility)
boolean	isWritable(CodeVisibility visibility)
default void	setModifiers(CodeModifiers modifiers)	Deprecated. the modifiers of a CodeProperty are calculated and cannot be modified.

Methods inherited from interface CodeElement

getAnnotations, getDoc, removeFromParent

Methods inherited from interface CodeElementWithName

setName

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

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, getReflectiveObject

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 CodeWithContext

getContext, getSource

Method Details

getField

CodeField getField()

Returns:

the CodeField corresponding to this property or null if no such field exists.

getGetter

CodeMethod getGetter()

Returns:

the CodeMethod representing the getter of this property or null if no such method exists.

getSetter

CodeMethod getSetter()

Returns:

the CodeMethod representing the setter of this property or null if no such method exists.

isPublicReadable

default boolean isPublicReadable()

Returns:

true if this property is public readable, false otherwise.

isPrivateReadable

default boolean isPrivateReadable()

Returns:

true if this property is private readable, false otherwise.

isReadable

boolean isReadable(CodeVisibility visibility)

Parameters:

visibility - the expected CodeVisibility.

Returns:

true if this property is readable through field or getter with the given CodeVisibility, false otherwise.

isPublicWritable

default boolean isPublicWritable()

Returns:

true if this property is public writable, false otherwise.

isPrivateWritable

default boolean isPrivateWritable()

Returns:

true if this property is private writable, false otherwise.

isWritable

boolean isWritable(CodeVisibility visibility)

Parameters:

visibility - the expected CodeVisibility.

Returns:

true if this property is writable through non-final field or setter with the given CodeVisibility, false otherwise.

inherit

CodeProperty inherit(CodeType declaring)

Parameters:

declaring - the new potential CodeItemWithDeclaringType.getDeclaringType().

Returns:

a new CodeProperty with its type being resolved or this property itself if the type could not be resolved any further.

setModifiers

@Deprecated
default void setModifiers(CodeModifiers modifiers)

Deprecated.

the modifiers of a CodeProperty are calculated and cannot be modified.

Specified by:

setModifiers in interface CodeElementWithModifiers

Parameters:

modifiers - the new modifiers.

Throws:

io.github.mmm.base.exception.ReadOnlyException - on every call.

copy

CodeProperty 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<CodeProperties, CodeProperty>

Returns:

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