Interface CodeAnnotation

All Superinterfaces:

CodeItem, CodeItemWithComment, CodeItemWithType, CodeMutable, CodeMutableItem, CodeMutableItemWithComment, CodeMutableItemWithType, CodeNode, CodeNodeItem, CodeNodeItemCopyable<CodeAnnotations, CodeAnnotation>, CodeWithContext

public interface CodeAnnotation
extends CodeMutableItemWithType, CodeMutableItemWithComment, CodeNodeItemCopyable<CodeAnnotations, CodeAnnotation>

CodeMutableItemWithType that represents an Annotation instance.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The String used as prefix for an annotation.
static final char	PREFIX_CHAR	The character used as prefix for an annotation.

Fields inherited from interface CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Method Summary

Modifier and Type	Method	Description
CodeAnnotation	copy()
CodeAnnotation	copy(CodeCopyMapper mapper)
Map<String, CodeExpression>	getParameters()
CodeAnnotations	getParent()
Annotation	getReflectiveObject()

Methods inherited from interface CodeItem

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

Methods inherited from interface CodeItemWithComment

getComment

Methods inherited from interface CodeItemWithType

getType

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 CodeWithContext

getContext, getSource

Field Details

PREFIX_CHAR

static final char PREFIX_CHAR

The character used as prefix for an annotation.

See Also:

• Constant Field Values

PREFIX

static final String PREFIX

The String used as prefix for an annotation.

See Also:

• Constant Field Values

Method Details

getParameters

Map<String, CodeExpression> getParameters()

Returns:

the Map with the parameters of this annotation. May be empty but is never null. The CodeExpressions are most likely a CodeConstant.

getReflectiveObject

Annotation getReflectiveObject()

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.

getParent

CodeAnnotations getParent()

Specified by:

getParent in interface CodeNode

Specified by:

getParent in interface CodeNodeItemCopyable<CodeAnnotations, CodeAnnotation>

Returns:

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

copy

CodeAnnotation copy()

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeAnnotations, CodeAnnotation>

Returns:

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

copy

CodeAnnotation copy(CodeCopyMapper mapper)

Specified by:

copy in interface CodeMutableItem

Specified by:

copy in interface CodeNodeItem

Specified by:

copy in interface CodeNodeItemCopyable<CodeAnnotations, CodeAnnotation>

Parameters:

mapper - the CodeCopyMapper used to map involved nodes during copy.

Returns:

a CodeMutableItem.copy() with the related objects mapped using the given CodeCopyMapper.