com.prosyst.mbs.framework.measurement
Interface FrameworkMeasurement

public interface FrameworkMeasurement

Field Summary

static int	BEGIN_SHUTDOWN_TIME Constant, which should be used in calls to trigger method.
static int	END_VM_STARTUP_TIME Constant, which should be used in calls to trigger method.
static java.lang.String	FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.
static java.lang.String	HEAP_MEMORY_USAGE_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.
static java.lang.String	HIERARCHICAL_VIEW_FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.
static int	MEMORY Constant, which should be used in calls to trigger method.
static java.lang.String	MEMORY_USAGE_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.
static java.lang.String	PROCESS_MEMORY_USAGE_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.
static java.lang.String	THREAD_COUNT_MEASUREMENT_PROPERTY Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method.

Method Summary

void	log(java.lang.String measurement, boolean display) Provides means for framework and bundles to log measurements.
void	trigger(int type, java.lang.String module) Triggers the beginning of a specific event.

Field Detail

END_VM_STARTUP_TIME

static final int END_VM_STARTUP_TIME

Constant, which should be used in calls to trigger method. END_VM_STARTUP_TIME indicates that the JVM has just started successfully and has entered in main method of the application.

See Also:

Constant Field Values

BEGIN_SHUTDOWN_TIME

static final int BEGIN_SHUTDOWN_TIME

Constant, which should be used in calls to trigger method. BEGIN_SHUTDOWN_TIME indicates that System.exit() call is just going to be performed.

See Also:

Constant Field Values

MEMORY

static final int MEMORY

Constant, which should be used in calls to trigger method. MEMORY indicates that memory measurements should be performed.

See Also:

Constant Field Values

HEAP_MEMORY_USAGE_MEASUREMENT_PROPERTY

static final java.lang.String HEAP_MEMORY_USAGE_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. HEAP_MEMORY_USAGE_MEASUREMENT_PROPERTY enables heap memory checks.

See Also:

Constant Field Values

PROCESS_MEMORY_USAGE_MEASUREMENT_PROPERTY

static final java.lang.String PROCESS_MEMORY_USAGE_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. PROCESS_MEMORY_USAGE_MEASUREMENT_PROPERTY enables process memory checks.

See Also:

Constant Field Values

FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY

static final java.lang.String FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY enables flash memory checks.

See Also:

Constant Field Values

MEMORY_USAGE_MEASUREMENT_PROPERTY

static final java.lang.String MEMORY_USAGE_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. MEMORY_USAGE_MEASUREMENT_PROPERTY enables heap, process and flash memory checks.

See Also:

Constant Field Values

THREAD_COUNT_MEASUREMENT_PROPERTY

static final java.lang.String THREAD_COUNT_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. THREAD_COUNT_MEASUREMENT_PROPERTY enables threads' count checks.

See Also:

Constant Field Values

HIERARCHICAL_VIEW_FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY

static final java.lang.String HIERARCHICAL_VIEW_FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY

Implementions of FrameworkMeasurement interface are supposed to use this constant in trigger method. HIERARCHICAL_VIEW_FLASH_MEMORY_USAGE_MEASUREMENT_PROPERTY enables flash memory checks with hierarchical reports for each subfolder of the main storage folder.

See Also:

Constant Field Values

Method Detail

log

void log(java.lang.String measurement,
         boolean display)

Provides means for framework and bundles to log measurements. Framework should use Debug.printDebug(int, int, String, boolean, boolean) method, which in its turn would use this method. Bundles should use com.prosyst.util.ref.Log.debug(int, int, String, Throwable, boolean, boolean) method, which in its turn would use this method.

Parameters:

measurement - - the measurement to log

display - - indicates whether the message should be displayed in native GUI

trigger

void trigger(int type,
             java.lang.String module)
             throws java.lang.IllegalArgumentException

Triggers the beginning of a specific event. The possible event types are:

END_VM_STARTUP_TIME

BEGIN_SHUTDOWN_TIME

MEMORY

Parameters:

type - - the type of the triggered event

module - - the module, which triggers the event

Throws:

java.lang.IllegalArgumentException - is thrown if unsupported type is specified