Interface CodeElement

All Superinterfaces:

CodeItem, CodeItemWithComment, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeNode, CodeNodeItem, CodeWithContext

All Known Subinterfaces:

CodeArrayType, CodeComposedType, CodeConstructor, CodeElementWithDeclaringType, CodeElementWithModifiers, CodeElementWithName, CodeElementWithTypeVariables, CodeException, CodeField, CodeFile, CodeGenericType, CodeMember, CodeMethod, CodeOperation, CodeOperationArg, CodePackage, CodeParameter, CodeParameterizedType, CodePathElement, CodeProperty, CodeReturn, CodeType, CodeTypePlaceholder, CodeTypeVariable, CodeTypeWildcard

public interface CodeElement
extends CodeNodeItem, CodeMutableItemWithComment

CodeMutableItemWithType that can be annotated, documented, or commented.

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
CodeElement	copy()
CodeAnnotations	getAnnotations()
CodeDoc	getDoc()
void	removeFromParent()	Destroys this node and disconnects it from its parent.

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeMutableItemWithComment

setComment

Methods inherited from interface CodeNode

getParent

Methods inherited from interface CodeNodeItem

copy

Methods inherited from interface CodeWithContext

getContext, getSource

Method Details

getDoc

CodeDoc getDoc()

Returns:

the documentation of this element. May be empty but will never be null.

getAnnotations

CodeAnnotations getAnnotations()

Returns:

the CodeAnnotations with the CodeAnnotations of this element.

removeFromParent

void removeFromParent()

Destroys this node and disconnects it from its parent.

Throws:

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

copy

CodeElement copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Returns:

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