Interface CodeAnnotations

All Superinterfaces:

CodeItem, CodeMergeableItem<CodeAnnotations>, CodeMutable, CodeMutableItem, CodeNode, CodeNodeContainer<CodeAnnotation>, CodeNodeItem, CodeNodeItemContainer<CodeAnnotation>, CodeNodeItemContainerHierarchical<CodeAnnotation>, CodeNodeItemCopyable<CodeElement, CodeAnnotations>, CodeSimpleMergeableItem<CodeAnnotations>, CodeWithContext, Iterable<CodeAnnotation>

public interface CodeAnnotations
extends CodeNodeItemContainerHierarchical<CodeAnnotation>, CodeSimpleMergeableItem<CodeAnnotations>, CodeNodeItemCopyable<CodeElement, CodeAnnotations>

CodeNodeItemContainerHierarchical containing CodeAnnotations.

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
void	add(CodeAnnotation annotation)
CodeAnnotation	add(CodeType type)
CodeAnnotations	copy()
Iterable<? extends CodeAnnotation>	getAll()	Attention: This method can be expensive as it has to traverse inherited elements.
CodeAnnotation	getDeclared(CodeType type)
default CodeAnnotation	getDeclaredOrAdd(CodeType type)
CodeElement	getParent()

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeMutable

isImmutable, isMutable

Methods inherited from interface CodeMutableItem

getReflectiveObject, setImmutable

Methods inherited from interface CodeNodeContainer

getDeclared, isEmpty, iterator

Methods inherited from interface CodeNodeItemContainer

copy, remove

Methods inherited from interface CodeNodeItemCopyable

copy

Methods inherited from interface CodeSimpleMergeableItem

merge, merge

Methods inherited from interface CodeWithContext

getContext, getSource

Methods inherited from interface Iterable

forEach, spliterator

Method Details

getParent

CodeElement getParent()

Specified by:

getParent in interface CodeNode

Specified by:

getParent in interface CodeNodeItemContainer<CodeAnnotation>

Specified by:

getParent in interface CodeNodeItemCopyable<CodeElement, CodeAnnotations>

Returns:

the parent of this CodeNode. May only be null for instances of CodeContext.

getAll

Iterable<? extends CodeAnnotation> getAll()

Attention:
This method can be expensive as it has to traverse inherited elements. However, due to the usage of Iterable implementations can lazily traverse.

Specified by:

getAll in interface CodeNodeItemContainerHierarchical<CodeAnnotation>

Returns:

the Iterable of all CodeItems as the union of the declared and its recursively traversed items. May be empty but is never null.

See Also:

• CodeMethod.getParentMethod()

add

CodeAnnotation add(CodeType type)

Parameters:

type - the type reflecting the annotation.

Returns:

the new CodeAnnotation that has been created and added.

add

void add(CodeAnnotation annotation)

Parameters:

annotation - the CodeAnnotation to add.

getDeclared

CodeAnnotation getDeclared(CodeType type)

Parameters:

type - the type reflecting the annotation.

Returns:

the CodeAnnotation from CodeNodeContainer.getDeclared() with the give CodeType or null if not found.

getDeclaredOrAdd

default CodeAnnotation getDeclaredOrAdd(CodeType type)

Parameters:

type - the type reflecting the annotation.

Returns:

the CodeAnnotation from CodeNodeContainer.getDeclared() with the give CodeType or a new added one.

copy

CodeAnnotations copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemContainer<CodeAnnotation>

Specified by:

copy in interface CodeNodeItemContainerHierarchical<CodeAnnotation>

Specified by:

copy in interface CodeNodeItemCopyable<CodeElement, CodeAnnotations>

Returns:

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