de.uni_hildesheim.sse.monitoring.runtime.configuration.xml

Class XMLConfiguration

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.configuration.xml.XMLConfiguration

public class XMLConfiguration
extends java.lang.Object

Represents an instrumenter configuration read from XML.

Since:

1.00

Version:

1.11

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
private HashMap<java.lang.String,java.lang.Boolean>	analyzeMembers Just stores whether the most detailed type of annotation attachment per class is a member (true) or not (false).
private HashMap<java.lang.String,AnnotationBuilderMap>	configuration Stores the configuration, i.e. a mapping from signatures to annotation types to annotation builders.
private boolean	exclusive Stores if this configuration is exclusive, i.e. authoritive or if it may overlap with source code annotations.
private HashMap<java.lang.String,MonitoringGroupConfiguration>	groupConfigurations Stores the group configurations.
private ArrayList<Pattern>	patterns Stores the patterns.

Constructor Summary

Constructors

Constructor and Description
XMLConfiguration()

Method Summary

Modifier and Type	Method and Description
HashMap<java.lang.String,java.lang.Boolean>	getAnalyzeMembers() Returns a mapping between class names and whether code analysis of members is required according to the configuration.
<T extends java.lang.annotation.Annotation> T	getAnnotation(java.lang.String signature, java.lang.Object classOfSignature, java.lang.Class<T> cls, IResolver resolver) Returns the annotation attached to the given signature.
private <T extends java.lang.annotation.Annotation> IAnnotationBuilder<?>	getBuilderForPattern(java.lang.String signature, java.lang.Object classOfSignature, java.lang.Class<T> cls, IResolver resolver) Returns the annotation builder derived from a pattern or a type constrained from the given signature.
MonitoringGroupConfiguration	getMonitoringGroupConfiguration(java.lang.String recId) Returns the monitoring group configuration for the specified recorder identification.
<T extends java.lang.annotation.Annotation> boolean	hasAnnotation(java.lang.String signature, java.lang.Object classOfSignature, java.lang.Class<T> cls, IResolver resolver) Returns if this configuration states that the given signature has an "annotation" of the given annotation class.
boolean	isExclusive() Returns if this configuration is exclusive, i.e. authoritive.
static XMLConfiguration	read(java.lang.String file) Reads a configuration from a given file.

Methods inherited from class java.lang.Object

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

Field Detail

configuration

private HashMap<java.lang.String,AnnotationBuilderMap> configuration

Stores the configuration, i.e. a mapping from signatures to annotation types to annotation builders.

patterns

private ArrayList<Pattern> patterns

Stores the patterns.

groupConfigurations

private HashMap<java.lang.String,MonitoringGroupConfiguration> groupConfigurations

Stores the group configurations.

exclusive

private boolean exclusive

Stores if this configuration is exclusive, i.e. authoritive or if it may overlap with source code annotations. Default is true.

analyzeMembers

private HashMap<java.lang.String,java.lang.Boolean> analyzeMembers

Just stores whether the most detailed type of annotation attachment per class is a member (true) or not (false). May be null if plain time recording is not configured as default monitoring, i.e., other resources are considered by default.

Since:

1.13

Constructor Detail

XMLConfiguration

public XMLConfiguration()

Method Detail

read

public static XMLConfiguration read(java.lang.String file)
                             throws java.io.IOException

Reads a configuration from a given file.

Parameters:

file - the file to read

Returns:

the read configuration

Throws:

java.io.IOException - in case of any reading error, including erroneous structures and unknown information

Since:

1.00

hasAnnotation

public <T extends java.lang.annotation.Annotation> boolean hasAnnotation(java.lang.String signature,
                                                                         java.lang.Object classOfSignature,
                                                                         java.lang.Class<T> cls,
                                                                         IResolver resolver)

Returns if this configuration states that the given signature has an "annotation" of the given annotation class.

Type Parameters:

T - the annotation type (inferred)

Parameters:

signature - the signature to search for (no return type, no spaces, no parameter names, no exceptions, fully qualified names only, prefixed fully qualified name for methods)

classOfSignature - an object representing the class of the signature. This instance may be passed to resolver and is therefore dependent on the implementation of the instrumenter

cls - the annotation class to match

resolver - an optional resolver instance to create annotations based on parameterized data on call (may be null)

Returns:

true if a mapping exist, i.e. an annotation is defined for the signature, false else

Since:

1.00

getAnnotation

public <T extends java.lang.annotation.Annotation> T getAnnotation(java.lang.String signature,
                                                                   java.lang.Object classOfSignature,
                                                                   java.lang.Class<T> cls,
                                                                   IResolver resolver)

Returns the annotation attached to the given signature.

Type Parameters:

T - the annotation type (inferred)

Parameters:

signature - the signature to search for (no return type, no spaces, no parameter names, no exceptions, fully qualified names only, prefixed fully qualified name for methods)

classOfSignature - an object representing the class of the signature. This instance may be passed to resolver and is therefore dependent on the implementation of the instrumenter

cls - the annotation class to match

resolver - an optional resolver instance to create annotations based on parameterized data on call (may be null)

Returns:

the annotation or null if not found

Since:

1.00

getBuilderForPattern

private <T extends java.lang.annotation.Annotation> IAnnotationBuilder<?> getBuilderForPattern(java.lang.String signature,
                                                                                               java.lang.Object classOfSignature,
                                                                                               java.lang.Class<T> cls,
                                                                                               IResolver resolver)

Returns the annotation builder derived from a pattern or a type constrained from the given signature.

Type Parameters:

T - the annotation type (inferred)

Parameters:

signature - the signature to search for (no return type, no spaces, no parameter names, no exceptions, fully qualified names only, prefixed fully qualified name for methods)

classOfSignature - an object representing the class of the signature. This instance may be passed to resolver and is therefore dependent on the implementation of the instrumenter

cls - the annotation class to match

resolver - an optional resolver instance to create annotations based on parameterized data on call (may be null)

Returns:

the annotation builder or null if not found

Since:

1.00

isExclusive

public boolean isExclusive()

Returns if this configuration is exclusive, i.e. authoritive.

Returns:

true if exclusive, false if it should be combined with source code annotations

Since:

1.00

getAnalyzeMembers

public HashMap<java.lang.String,java.lang.Boolean> getAnalyzeMembers()

Returns a mapping between class names and whether code analysis of members is required according to the configuration.

Returns:

the mapping of (Java) class names and whether analysis is required

Since:

1.13

getMonitoringGroupConfiguration

public MonitoringGroupConfiguration getMonitoringGroupConfiguration(java.lang.String recId)

Returns the monitoring group configuration for the specified recorder identification.

Parameters:

recId - the recorder identification to return the configuration for

Returns:

the group configuration (may be MonitoringGroupConfiguration.DEFAULT but not null)

Since:

1.00