Package net.ssehub.easy.instantiation.java.artifacts

Class JavaAnnotation

java.lang.Object

net.ssehub.easy.instantiation.core.model.artifactModel.FragmentArtifact

net.ssehub.easy.instantiation.java.artifacts.JavaFragmentArtifact

net.ssehub.easy.instantiation.java.artifacts.JavaAnnotation

All Implemented Interfaces:

IArtifact, IStringValueProvider, IVilType

public class JavaAnnotation
extends JavaFragmentArtifact

Represents a Java annotation.

Author:

Holger Eichelberger, Sass

Nested Class Summary

Nested classes/interfaces inherited from interface net.ssehub.easy.instantiation.core.model.vilTypes.IStringValueProvider

IStringValueProvider.StringComparator

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static java.lang.String	DEFAULT_FIELD
private java.util.Map<java.lang.String,java.lang.String>	fields
private java.lang.String	qualifiedName
private java.lang.String	simpleName

Constructor Summary

Constructors

Constructor	Description
JavaAnnotation(java.lang.String name, java.util.Map<java.lang.String,java.lang.String> fields, IJavaParent parent)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
void	accept(IArtifactVisitor visitor)	Visits this artifact (and dependent on the visitor also contained artifacts and fragments) using the given visitor.
void	delete()	Deletes this artifact.
Set<java.lang.String>	fields()	Returns the fields of this annotation.
java.lang.String	getAnnotationValue(java.lang.String field)	Returns the annotation value as a string.
Binary	getBinary()	Returns the binary representation of the contents of this artifact for manipulation.
java.lang.String	getName()	Returns the name of this artifact.
java.lang.String	getQualifiedName()	Returns the qualified name of the annotation.
java.lang.String	getStringValue(IStringValueProvider.StringComparator comparator)	Returns the string value of this object.
Text	getText()	Returns the textual representation of the contents of this artifact for manipulation.
void	rename(java.lang.String name)	Renames this artifact.
(package private) static java.lang.String	toSimpleName(java.lang.String name)	Returns the simple name of a possible qualified name.

Methods inherited from class net.ssehub.easy.instantiation.java.artifacts.JavaFragmentArtifact

getNameSafe, getParent, notifyChanged, store, update

Methods inherited from class net.ssehub.easy.instantiation.core.model.artifactModel.FragmentArtifact

exists, lastModification

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FIELD

static final java.lang.String DEFAULT_FIELD

See Also:

Constant Field Values

qualifiedName

private java.lang.String qualifiedName

simpleName

private java.lang.String simpleName

fields

private java.util.Map<java.lang.String,java.lang.String> fields

Constructor Detail

JavaAnnotation

public JavaAnnotation(java.lang.String name,
                      java.util.Map<java.lang.String,java.lang.String> fields,
                      IJavaParent parent)

Default Constructor.

Parameters:

name - The annotation name

fields - the annotation fields (name-value mapping)

parent - the parent artifact or fragment

Method Detail

toSimpleName

static java.lang.String toSimpleName(java.lang.String name)

Returns the simple name of a possible qualified name.

Parameters:

name - the name

Returns:

the simple name

delete

public void delete()
            throws VilException

Description copied from interface: IArtifact

Deletes this artifact.

Specified by:

delete in interface IArtifact

Overrides:

delete in class JavaFragmentArtifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

getName

public java.lang.String getName()
                         throws VilException

Description copied from interface: IArtifact

Returns the name of this artifact.

Returns:

the name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

getQualifiedName

public java.lang.String getQualifiedName()

Returns the qualified name of the annotation.

Returns:

the qualified name

rename

public void rename(java.lang.String name)
            throws VilException

Description copied from interface: IArtifact

Renames this artifact.

Parameters:

name - the new name of this artifact

Throws:

VilException - in case of serious problems so that this operation cannot continue

getText

public Text getText()
             throws VilException

Description copied from interface: IArtifact

Returns the textual representation of the contents of this artifact for manipulation. In case of binary artifacts, the returned object may be empty.

Returns:

the textual representation of the contents

Throws:

VilException - in case of obtaining the representation causes serious problems

getBinary

public Binary getBinary()
                 throws VilException

Description copied from interface: IArtifact

Returns the binary representation of the contents of this artifact for manipulation.

Returns:

the binary representation of the contents

Throws:

VilException - in case of obtaining the representation causes serious problems

accept

public void accept(IArtifactVisitor visitor)

Description copied from interface: IArtifact

Visits this artifact (and dependent on the visitor also contained artifacts and fragments) using the given visitor.

Parameters:

visitor - the visitor used for visiting this artifact

fields

public Set<java.lang.String> fields()

Returns the fields of this annotation.

Returns:

the fields

getAnnotationValue

public java.lang.String getAnnotationValue(java.lang.String field)

Returns the annotation value as a string.

Parameters:

field - the name of the field to return

Returns:

The annotation value represented as a string, may be null of not found.

getStringValue

public java.lang.String getStringValue(IStringValueProvider.StringComparator comparator)

Description copied from interface: IStringValueProvider

Returns the string value of this object.

Parameters:

comparator - if the sequence of elements, e.g., in case of collections, shall be ordered according to the comparator, null if the original sequence shall be returned

Returns:

the string value