de.uni_hildesheim.sse.monitoring.runtime.annotations

Class Helper

java.lang.Object

de.uni_hildesheim.sse.monitoring.runtime.annotations.Helper

public class Helper
extends java.lang.Object

Some helper methods / constants for the annotations.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTEXTUALIZE_ID Used for ids which are defined generically and should consider the thread-stacked context id (if present).
static java.lang.String	EXCLUDED_ID Defines the internal id for explicitly monitoring excluded parts.
static java.lang.String	IGNORE_ID Currently used for abstract classes ("*").
static java.lang.String	PROGRAM_ID Defines the internal id for recording the monitored program itself.
static java.lang.String	PSEUDO_ID_PREFIX Defines the prefix for internally created ids ("*pseudo").
static java.lang.String	RECORDER_ID Defines the internal id for overhead monitoring, i.e. monitoring the monitoring framework itself.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Helper() Prevents this class from being instantiated from outside.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	createPseudo(int id) Returns a pseudo id.
static java.lang.String	getCheckedId(java.lang.String recId) Checks the ID (for ignored ids) and returns the id (or a modified return value).
static boolean	ignore(Monitor group) Returns if this annotation should be ignored.
static boolean	ignore(java.lang.String recId) Returns if recId should be ignored.
static boolean	isContextualizeId(java.lang.String id) Returns if the given id requires contextualization.
static boolean	isId(Monitor group, java.lang.String recId) Returns if the given recId is equal to the (first and only) recorder id in group.
static boolean	isPseudo(java.lang.String recId) Returns whether the given recId is a pseudo id.
static java.lang.String	trimId(java.lang.String recId) Trims the recording id, i.e. removes leading and trailing spaces.

Methods inherited from class java.lang.Object

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

Field Detail

RECORDER_ID

public static final java.lang.String RECORDER_ID

Defines the internal id for overhead monitoring, i.e. monitoring the monitoring framework itself. Do not use this for annotating your classes ("*recorder*").

See Also:

Constant Field Values

EXCLUDED_ID

public static final java.lang.String EXCLUDED_ID

Defines the internal id for explicitly monitoring excluded parts. Do not use this for annotating your classes ("*excluded*").

See Also:

Constant Field Values

PSEUDO_ID_PREFIX

public static final java.lang.String PSEUDO_ID_PREFIX

Defines the prefix for internally created ids ("*pseudo").

See Also:

Constant Field Values

PROGRAM_ID

public static final java.lang.String PROGRAM_ID

Defines the internal id for recording the monitored program itself. Do not use this for annotating your classes ("program").

See Also:

Constant Field Values

IGNORE_ID

public static final java.lang.String IGNORE_ID

Currently used for abstract classes ("*"). Consider generically for recording .

See Also:

Constant Field Values

CONTEXTUALIZE_ID

public static final java.lang.String CONTEXTUALIZE_ID

Used for ids which are defined generically and should consider the thread-stacked context id (if present).

See Also:

Constant Field Values

Constructor Detail

Helper

private Helper()

Prevents this class from being instantiated from outside.

Since:

1.00

Method Detail

ignore

public static boolean ignore(Monitor group)

Returns if this annotation should be ignored.

Parameters:

group - the annotation to be tested

Returns:

true if it should be ignored, false else

Since:

1.00

isId

public static boolean isId(Monitor group,
                           java.lang.String recId)

Returns if the given recId is equal to the (first and only) recorder id in group.

Parameters:

group - the group to be taken into account

recId - the recorder id to test for

Returns:

true if equals, false else

Since:

1.00

isPseudo

public static boolean isPseudo(java.lang.String recId)

Returns whether the given recId is a pseudo id.

Parameters:

recId - the id to be tested

Returns:

true if recId is a pseudo id, false else

Since:

1.00

createPseudo

public static java.lang.String createPseudo(int id)

Returns a pseudo id.

Parameters:

id - a numeric id

Returns:

the pseudo id including the numeric id

Since:

1.00

ignore

public static boolean ignore(java.lang.String recId)

Returns if recId should be ignored.

Parameters:

recId - the id to be tested

Returns:

true if it should be ignored, false else

Since:

1.00

isContextualizeId

public static boolean isContextualizeId(java.lang.String id)

Returns if the given id requires contextualization.

Parameters:

id - the id to be checked

Returns:

true if it is an id which requires contextualization, false else

getCheckedId

public static java.lang.String getCheckedId(java.lang.String recId)

Checks the ID (for ignored ids) and returns the id (or a modified return value).

Parameters:

recId - the recording identification to be checked

Returns:

recId or null in case that it should be ignored

Since:

1.00

trimId

public static java.lang.String trimId(java.lang.String recId)

Trims the recording id, i.e. removes leading and trailing spaces.

Parameters:

recId - the recording id (may be null)

Returns:

the trimmed id

Since:

1.00