de.uni_hildesheim.sse.monitoring.runtime.boot

Enum MainDefaultType

java.lang.Object

java.lang.Enum<MainDefaultType>

de.uni_hildesheim.sse.monitoring.runtime.boot.MainDefaultType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MainDefaultType>

public enum MainDefaultType
extends java.lang.Enum<MainDefaultType>

Defines the default instrumentation behavior in case that no annotations or configuration is given for the start and end of monitoring activities.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Enum Constant Summary

Enum Constants

Enum Constant and Description
END Instrument end of monitoring at end of main by default.
NONE Do nothing, rely on annotations only.
SHUTDOWN Instrument end of monitoring by shutdown hook.
START Instrument startup of monitoring at beginning of main by default.
START_END Combines START and END.
START_END_SHUTDOWN Combines START and END and SHUTDOWN.
START_SHUTDOWN Combines START and SHUTDOWN.
START_STOP Deprecated. use START_END instead

Field Summary

Fields

Modifier and Type	Field and Description
private int	flags Stores the flags from MainDefaultTypeConstants.

Method Summary

Modifier and Type	Method and Description
boolean	atShutdown() Returns whether default instrumentation should happen as a shutdown hook.
boolean	atStart() Returns whether default instrumentation should happen at the beginning.
boolean	atStop() Returns whether default instrumentation should happen at the end.
static MainDefaultType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static MainDefaultType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final MainDefaultType NONE

Do nothing, rely on annotations only.

START

public static final MainDefaultType START

Instrument startup of monitoring at beginning of main by default.

END

public static final MainDefaultType END

Instrument end of monitoring at end of main by default.

SHUTDOWN

public static final MainDefaultType SHUTDOWN

Instrument end of monitoring by shutdown hook.

START_END

public static final MainDefaultType START_END

Combines START and END.

START_STOP

public static final MainDefaultType START_STOP

Deprecated. use START_END instead

Combines START and END.

START_SHUTDOWN

public static final MainDefaultType START_SHUTDOWN

Combines START and SHUTDOWN.

START_END_SHUTDOWN

public static final MainDefaultType START_END_SHUTDOWN

Combines START and END and SHUTDOWN.

Field Detail

flags

private int flags

Stores the flags from MainDefaultTypeConstants.

Method Detail

values

public static MainDefaultType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MainDefaultType c : MainDefaultType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MainDefaultType valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

atStart

public boolean atStart()

Returns whether default instrumentation should happen at the beginning.

Returns:

true if it should happen at the beginning, false else

Since:

1.00

atStop

public boolean atStop()

Returns whether default instrumentation should happen at the end.

Returns:

true if it should happen at the end, false else

Since:

1.00

atShutdown

public boolean atShutdown()

Returns whether default instrumentation should happen as a shutdown hook.

Returns:

true if it should happen as a shutdown hook, false else

Since:

1.00