de.uni_hildesheim.sse.monitoring.runtime.annotations

Annotation Type NotifyValue

@Retention(value=RUNTIME)
 @Target(value={METHOD,CONSTRUCTOR})
public @interface NotifyValue

Notify about a value to be considered as monitored value, e.g. in case of commonly used structures or protocols. Currenty, this annotation can be used in four different ways:

1. Notify about a value at the beginning of a method (notifyDifference() is false in this case). The value is determined by the expression in expression() and assigned to value(). id() may be given or the surrounding group id is used.
2. Notify about a difference of a value taken at the beginning of a method (determined by the expression in expression() and assigned to value()) and at the end of the method. (notifyDifference() is true in this case). id() may be given or the surrounding group id is used.
3. Notify about a value change in a library object, e.g. an IncrementalAverageCalculator defined in a jar library which cannot accessed as source modifies a value - then expression may notify the new value to the recorder. Id may be the direct id or be taken from ValueContext. In this case notifyDifference() is ignored.
4. Assign all values to id() if value() is MeasurementValue.ALL. In this case, id() may refer to a concrete id, the variability prefix or the group id is taken if the id is not given. notifyDifference() and expression() are ignored.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	expression An expression determining the value to be notified.
MeasurementValue	value The value to be modified.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	id The monitoring group to be notified.
boolean	notifyDifference Notify the value itself or the difference between entering the method and exiting it.
java.lang.String	tagExpression An optional expression which is used to determine the tag for the memory allocation.

Element Detail

expression

public abstract java.lang.String expression

An expression determining the value to be notified. Usually a static expression on parameters of the method, denoted as $1, ..., $n with $0 as this for instance methods nor null for static methods. Currently, we require only method calls to be supported - calculations can be done in static methods being excluded from monitoring.

Returns:

return the expression determining the value

Since:

1.00

value

public abstract MeasurementValue value

The value to be modified.

Returns:

the value/resource

Since:

1.00

id

public abstract java.lang.String id

The monitoring group to be notified.

Returns:

the group identification

Since:

1.00

See Also:

Monitor

Default:

""

tagExpression

public abstract java.lang.String tagExpression

An optional expression which is used to determine the tag for the memory allocation. This should point to the object being allocated or unallocated. Only effective in combination with MeasurementValue.MEM_ALLOCATED or MeasurementValue.MEM_UNALLOCATED.

Returns:

the memory tag, none if empty (default)

Since:

1.00

Default:

""

notifyDifference

public abstract boolean notifyDifference

Notify the value itself or the difference between entering the method and exiting it.

Returns:

true for difference, false else (default)

Since:

1.00

Default:

false