de.uni_hildesheim.sse.monitoring.runtime.configuration

Class AnnotationBuilder<T extends java.lang.annotation.Annotation>

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.configuration.AnnotationBuilder<T>

Type Parameters:

T - the annotation type

All Implemented Interfaces:

IAnnotationBuilder<T>

public class AnnotationBuilder<T extends java.lang.annotation.Annotation>
extends java.lang.Object
implements IAnnotationBuilder<T>

Implements the default way of creating annotations on demand. Instances of this class are intended to be used as template instances as well as concrete instances.

Since:

1.00

Version:

1.11

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Class<T>	cls Stores the concrete type of the annotation.
private HashMap<java.lang.String,java.lang.Object>	data Stores the concrete values of the annotation (method name - value).
private AttributeMetaData[]	dataDefinition Stores the data attributes in order to implement generic XML reading.
private T	instance Stores the instance of the annotation (created only once on demand).

Constructor Summary

Constructors

Modifier	Constructor and Description
private	AnnotationBuilder(AnnotationBuilder<T> builder) Creates an annotation builder from a given annotation builder by copying the relevant data, resetting instance and initializing data with default values (see setDefaults().
	AnnotationBuilder(java.lang.Class<T> cls) Creates an instance for a concrete annotation by reading the metadata directly from the annotation.
	AnnotationBuilder(java.lang.Class<T> cls, AttributeMetaData[] dataDefinition) Creates an instance of this builder by providing the meta information for each attribute to be considered.

Method Summary

Modifier and Type	Method and Description
T	create() Creates the annotation.
boolean	defaultsOnly() Returns whether the values of this annotation just contains defaults.
void	endElement(java.lang.String qName, boolean nested) Is called at the end of an XML element processing step.
private java.lang.Object	getEnumValue(java.lang.Class<?> type, java.lang.String attribute, java.lang.Object deflt) Returns the matching enum constant.
java.lang.Class<T>	getInstanceClass() Returns the concrete type of the annotation.
AnnotationBuilder<T>	prepareForUse() Prepares a template instance for use.
protected void	setBooleanData(java.lang.String key, HashMap<java.lang.String,java.lang.String> attributes, java.lang.Boolean deflt) Sets a string data from an attribute.
void	setData(java.lang.String key, java.lang.Object value) Sets a data value directly.
private void	setDefaults() Initializes the data of the annotation to be created with the default values.
protected <E extends java.lang.Enum<E>> void	setEnumData(java.lang.String key, HashMap<java.lang.String,java.lang.String> attributes, java.lang.Class<E> values, E deflt) Sets an enum data from an attribute.
protected void	setStringData(java.lang.String key, HashMap<java.lang.String,java.lang.String> attributes, java.lang.String deflt) Sets a string data from an attribute.
void	startElement(java.lang.String qName, boolean nested, HashMap<java.lang.String,java.lang.String> attributes) Is called at the beginning of an XML element processing step.
java.lang.String	toString() Returns a textual representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

instance

private T extends java.lang.annotation.Annotation instance

Stores the instance of the annotation (created only once on demand).

data

private HashMap<java.lang.String,java.lang.Object> data

Stores the concrete values of the annotation (method name - value).

cls

private java.lang.Class<T extends java.lang.annotation.Annotation> cls

Stores the concrete type of the annotation.

dataDefinition

private AttributeMetaData[] dataDefinition

Stores the data attributes in order to implement generic XML reading.

Constructor Detail

AnnotationBuilder

public AnnotationBuilder(java.lang.Class<T> cls,
                         AttributeMetaData[] dataDefinition)

Creates an instance of this builder by providing the meta information for each attribute to be considered.

Parameters:

cls - the type of the annotation

dataDefinition - the meta data

Since:

1.00

AnnotationBuilder

public AnnotationBuilder(java.lang.Class<T> cls)

Creates an instance for a concrete annotation by reading the metadata directly from the annotation.

Parameters:

cls - the annotation class {

Since:

1.00

AnnotationBuilder

private AnnotationBuilder(AnnotationBuilder<T> builder)

Creates an annotation builder from a given annotation builder by copying the relevant data, resetting instance and initializing data with default values (see setDefaults().

Parameters:

builder - the builder to copy from

Since:

1.00

Method Detail

getInstanceClass

public java.lang.Class<T> getInstanceClass()

Returns the concrete type of the annotation.

Specified by:

getInstanceClass in interface IAnnotationBuilder<T extends java.lang.annotation.Annotation>

Returns:

the concrete type

Since:

1.00

create

public final T create()

Creates the annotation.

Specified by:

create in interface IAnnotationBuilder<T extends java.lang.annotation.Annotation>

Returns:

the annotation

Since:

1.00

endElement

public void endElement(java.lang.String qName,
                       boolean nested)
                throws QdParserException

Is called at the end of an XML element processing step.

Parameters:

qName - the qualified name of the element

nested - if the element is nested as an unknown element in a known element

Throws:

QdParserException - in case of any processing error

Since:

1.00

startElement

public void startElement(java.lang.String qName,
                         boolean nested,
                         HashMap<java.lang.String,java.lang.String> attributes)
                  throws QdParserException

Is called at the beginning of an XML element processing step.

Parameters:

qName - the qualified name of the element

nested - if the element is nested as an unknown element in a known element

attributes - the actual XML attributes

Throws:

QdParserException - in case of any processing error

Since:

1.00

defaultsOnly

public boolean defaultsOnly()

Returns whether the values of this annotation just contains defaults.

Returns:

true if only defaults are set, false else

Since:

1.11

getEnumValue

private java.lang.Object getEnumValue(java.lang.Class<?> type,
                                      java.lang.String attribute,
                                      java.lang.Object deflt)

Returns the matching enum constant.

Parameters:

type - the type of the enumeration

attribute - the attribute value

deflt - the default value in case that the attribute is not defined (may be null)

Returns:

the enum value

Since:

1.00

setData

public void setData(java.lang.String key,
                    java.lang.Object value)

Sets a data value directly.

Parameters:

key - the name of the element / attribute.

value - the assigned value (must match the type in T)

Since:

1.00

setStringData

protected void setStringData(java.lang.String key,
                             HashMap<java.lang.String,java.lang.String> attributes,
                             java.lang.String deflt)
                      throws QdParserException

Sets a string data from an attribute.

Parameters:

key - the name of the attribute / element

attributes - the actual attributes

deflt - the default value in case that the attribute is not defined (may be null)

Throws:

QdParserException - in case of any processing error

Since:

1.00

setEnumData

protected <E extends java.lang.Enum<E>> void setEnumData(java.lang.String key,
                                                         HashMap<java.lang.String,java.lang.String> attributes,
                                                         java.lang.Class<E> values,
                                                         E deflt)
                                                  throws QdParserException

Sets an enum data from an attribute.

Type Parameters:

E - the type of the enum

Parameters:

key - the name of the attribute / element

attributes - the actual attributes

values - the class of the enum

deflt - the default value in case that the attribute is not defined (may be null)

Throws:

QdParserException - in case of any processing error

Since:

1.00

setBooleanData

protected void setBooleanData(java.lang.String key,
                              HashMap<java.lang.String,java.lang.String> attributes,
                              java.lang.Boolean deflt)
                       throws QdParserException

Sets a string data from an attribute.

Parameters:

key - the name of the attribute / element

attributes - the actual attributes

deflt - the default value in case that the attribute is not defined (may be null)

Throws:

QdParserException - in case of any processing error

Since:

1.00

prepareForUse

public AnnotationBuilder<T> prepareForUse()

Prepares a template instance for use.

Returns:

the instance to be used

Since:

1.00

setDefaults

private void setDefaults()

Initializes the data of the annotation to be created with the default values.

Since:

1.00

toString

public java.lang.String toString()

Returns a textual representation of this object.

Overrides:

toString in class java.lang.Object

Returns:

the textual representation