Class BaseAnnotation

java.lang.Object

io.github.mmm.code.base.item.BaseItem

io.github.mmm.code.base.item.BaseMutableItem

io.github.mmm.code.base.node.BaseNodeItem

io.github.mmm.code.base.annoation.BaseAnnotation

All Implemented Interfaces:

io.github.mmm.code.api.annotation.CodeAnnotation, io.github.mmm.code.api.CodeWithContext, io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.annotation.CodeAnnotations, io.github.mmm.code.api.annotation.CodeAnnotation>, io.github.mmm.code.api.item.CodeItem, io.github.mmm.code.api.item.CodeItemWithComment, io.github.mmm.code.api.item.CodeItemWithType, io.github.mmm.code.api.item.CodeMutableItem, io.github.mmm.code.api.item.CodeMutableItemWithComment, io.github.mmm.code.api.item.CodeMutableItemWithType, io.github.mmm.code.api.node.CodeNode, io.github.mmm.code.api.node.CodeNodeItem, io.github.mmm.code.api.object.CodeMutable

public class BaseAnnotation
extends BaseNodeItem
implements io.github.mmm.code.api.annotation.CodeAnnotation

Base implementation of CodeAnnotation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface io.github.mmm.code.api.annotation.CodeAnnotation

PREFIX, PREFIX_CHAR

Fields inherited from interface io.github.mmm.code.api.item.CodeItem

DEFAULT_INDENT, DEFAULT_NEWLINE

Constructor Summary

Constructors

Constructor	Description
BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent, io.github.mmm.code.api.type.CodeType type)	The constructor.
BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent, Annotation reflectiveObject)	The constructor.
BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent, String typeName, String qualifiedTypeName)	The constructor.
BaseAnnotation(BaseAnnotation template, io.github.mmm.code.api.copy.CodeCopyMapper mapper)	The copy-constructor.

Method Summary

Modifier and Type	Method	Description
BaseAnnotation	copy()
BaseAnnotation	copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)
protected void	doInitialize()	Called from BaseMutableItem.initialize() on first invocation.
protected void	doSetImmutable()	Called on the first call of BaseMutableItem.setImmutable().
protected void	doWrite(Appendable sink, String newline, String defaultIndent, String currentIndent, io.github.mmm.code.api.language.CodeLanguage language)
io.github.mmm.code.api.comment.CodeComment	getComment()
Map<String, io.github.mmm.code.api.expression.CodeExpression>	getParameters()
io.github.mmm.code.api.annotation.CodeAnnotations	getParent()
Annotation	getReflectiveObject()
io.github.mmm.code.api.type.CodeGenericType	getType()
void	setComment(io.github.mmm.code.api.comment.CodeComment comment)
void	setType(io.github.mmm.code.api.type.CodeGenericType type)

Methods inherited from class BaseNodeItem

getContainerItem, getContainerItemDeclared, getContext, getLanguage, getSource, toPathString

Methods inherited from class BaseMutableItem

doCopyNode, doCopyNodeUnsafe, doMapList, doneInitialize, getDefaultCopyMapper, getDefaultEncoding, getSourceCodeObject, initialize, initialize, isImmutable, isInitialized, isInitializing, isSystemImmutable, isSystemImmutable, makeImmutable, makeImmutable, setImmutable, setImmutableIfNotSystemImmutable, verifyMutalbe, writeItem

Methods inherited from class BaseItem

getOwningType, getSourceCode, getSpaces, toString, write

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.github.mmm.code.api.item.CodeItem

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

Methods inherited from interface io.github.mmm.code.api.object.CodeMutable

isImmutable, isMutable

Methods inherited from interface io.github.mmm.code.api.item.CodeMutableItem

setImmutable

Methods inherited from interface io.github.mmm.code.api.CodeWithContext

getContext, getSource

Constructor Details

BaseAnnotation

public BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent,
 Annotation reflectiveObject)

The constructor.

Parameters:

parent - the parent.

reflectiveObject - the reflective object.

BaseAnnotation

public BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent,
 io.github.mmm.code.api.type.CodeType type)

The constructor.

Parameters:

parent - the parent.

type - the type.

BaseAnnotation

public BaseAnnotation(io.github.mmm.code.api.annotation.CodeAnnotations parent,
 String typeName,
 String qualifiedTypeName)

The constructor.

Parameters:

parent - the parent.

typeName - the name of the type from the source-code.

qualifiedTypeName - the qualified type.

BaseAnnotation

public BaseAnnotation(BaseAnnotation template,
 io.github.mmm.code.api.copy.CodeCopyMapper mapper)

The copy-constructor.

Parameters:

template - the BaseAnnotation to copy.

mapper - the CodeCopyMapper.

Method Details

doInitialize

protected void doInitialize()

Description copied from class: BaseNodeItem

Called from BaseMutableItem.initialize() on first invocation. May be overridden but never be called from anywhere else.

Overrides:

doInitialize in class BaseNodeItem

doSetImmutable

protected void doSetImmutable()

Description copied from class: BaseMutableItem

Called on the first call of BaseMutableItem.setImmutable(). Has to be overridden to update Collections, make child items immutable, etc.

Overrides:

doSetImmutable in class BaseMutableItem

getParent

public io.github.mmm.code.api.annotation.CodeAnnotations getParent()

Specified by:

getParent in interface io.github.mmm.code.api.annotation.CodeAnnotation

Specified by:

getParent in interface io.github.mmm.code.api.node.CodeNode

Specified by:

getParent in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.annotation.CodeAnnotations, io.github.mmm.code.api.annotation.CodeAnnotation>

getType

public io.github.mmm.code.api.type.CodeGenericType getType()

Specified by:

getType in interface io.github.mmm.code.api.item.CodeItemWithType

setType

public void setType(io.github.mmm.code.api.type.CodeGenericType type)

Specified by:

setType in interface io.github.mmm.code.api.item.CodeMutableItemWithType

getParameters

public Map<String, io.github.mmm.code.api.expression.CodeExpression> getParameters()

Specified by:

getParameters in interface io.github.mmm.code.api.annotation.CodeAnnotation

getComment

public io.github.mmm.code.api.comment.CodeComment getComment()

Specified by:

getComment in interface io.github.mmm.code.api.item.CodeItemWithComment

setComment

public void setComment(io.github.mmm.code.api.comment.CodeComment comment)

Specified by:

setComment in interface io.github.mmm.code.api.item.CodeMutableItemWithComment

getReflectiveObject

public Annotation getReflectiveObject()

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.annotation.CodeAnnotation

Specified by:

getReflectiveObject in interface io.github.mmm.code.api.item.CodeMutableItem

Overrides:

getReflectiveObject in class BaseMutableItem

doWrite

protected void doWrite(Appendable sink,
 String newline,
 String defaultIndent,
 String currentIndent,
 io.github.mmm.code.api.language.CodeLanguage language)
                throws IOException

Specified by:

doWrite in class BaseItem

Parameters:

sink - the Appendable where to append the code from this CodeItem.

newline - the newline String.

defaultIndent - the String used for indentation (e.g. a number of spaces to insert per indent level).

currentIndent - the current indent (number of spaces). Initially the empty string (""). Before a recursion the defaultIndent will be appended.

language - the CodeLanguage to use.

Throws:

IOException - if thrown by Appendable.

See Also:

• CodeItem.write(Appendable, String, String)

copy

public BaseAnnotation copy()

Specified by:

copy in interface io.github.mmm.code.api.annotation.CodeAnnotation

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.annotation.CodeAnnotations, io.github.mmm.code.api.annotation.CodeAnnotation>

copy

public BaseAnnotation copy(io.github.mmm.code.api.copy.CodeCopyMapper mapper)

Specified by:

copy in interface io.github.mmm.code.api.annotation.CodeAnnotation

Specified by:

copy in interface io.github.mmm.code.api.item.CodeMutableItem

Specified by:

copy in interface io.github.mmm.code.api.node.CodeNodeItem

Specified by:

copy in interface io.github.mmm.code.api.copy.CodeNodeItemCopyable<io.github.mmm.code.api.annotation.CodeAnnotations, io.github.mmm.code.api.annotation.CodeAnnotation>