com.screenscraper.statistics

Enum SystemStatisticsTracker

java.lang.Object

java.lang.Enum<SystemStatisticsTracker>

com.screenscraper.statistics.SystemStatisticsTracker

All Implemented Interfaces:

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

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

Class for monitoring the CPU load

Version:

1.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE The unique instance

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.log4j.Logger	log Used for logging.

Method Summary

Modifier and Type	Method and Description
(package private) void	checkExcessMemoryUse(double currentUse) Checks to see if a current amount of memory use is beyond the thresholds set, and logs a message if required
double	getAverageMemoryUsePercent() Returns the average memory use as a percent from 0 to 100 (with 1 decimal point precision)
double	getAverageSystemCpuUsePercent() Returns the average cpu use for the system as a percent from 0 to 100 (with 1 decimal point precision)
double	getCurrentSystemCpuUsePercent() Returns the current cpu use for the system as a percent from 0 to 100 (with 1 decimal point precision)
double	getMemoryUseAfterLastGC() Returns the memory use immediately after the last garbage collection was run as a percent from 0 to 100 (with 1 decimal point precision)
static SystemStatisticsTracker	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SystemStatisticsTracker[]	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

INSTANCE

public static final SystemStatisticsTracker INSTANCE

The unique instance

Field Detail

log

public static org.apache.log4j.Logger log

Used for logging.

Method Detail

values

public static SystemStatisticsTracker[] 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 (SystemStatisticsTracker c : SystemStatisticsTracker.values())
    System.out.println(c);

Returns:

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

valueOf

public static SystemStatisticsTracker 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

checkExcessMemoryUse

void checkExcessMemoryUse(double currentUse)

Checks to see if a current amount of memory use is beyond the thresholds set, and logs a message if required

Parameters:

currentUse - The current percent of memory being used

getAverageMemoryUsePercent

public double getAverageMemoryUsePercent()

Returns the average memory use as a percent from 0 to 100 (with 1 decimal point precision)

Returns:

The average memory use, or 0 if it failed to read

getMemoryUseAfterLastGC

public double getMemoryUseAfterLastGC()

Returns the memory use immediately after the last garbage collection was run as a percent from 0 to 100 (with 1 decimal point precision)

Returns:

The memory use immediately after the last garbage collection was run, or 0 if it failed to read

getAverageSystemCpuUsePercent

public double getAverageSystemCpuUsePercent()

Returns the average cpu use for the system as a percent from 0 to 100 (with 1 decimal point precision)

Returns:

The average cpu use for the system, or 0 if it failed to read

getCurrentSystemCpuUsePercent

public double getCurrentSystemCpuUsePercent()

Returns the current cpu use for the system as a percent from 0 to 100 (with 1 decimal point precision)

Returns:

The current cpu use for the system, or 0 if it failed to read