com.ibm.java.diagnostics.healthcenter.api.gc

Class GCPreferences

java.lang.Object

com.ibm.java.diagnostics.healthcenter.api.gc.GCPreferences

public class GCPreferences
extends java.lang.Object

This class allows applications to retrieve or set various preferences that are relevant to the garbage collection data

Constructor Summary

Constructors

Constructor and Description
GCPreferences() Initializes the default set of preferences.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCompactionPercentageThreshold() Gets the threshold above which a warning is given for excessive compaction.
int	getHighOccupancyThreshold() Gets the threshold above which a warning is given for high occupancy.
int	getLowOccupancyThreshold() Gets the threshold below which a warning is given for low occupancy.
int	getPauseLengthThreshold() Gets the threshold above which a warning is given for long pauses.
int	getSystemGCPercentageThreshold() Gets the threshold above which a warning is given for excessive system garbage collections.
void	setCompactionPercentageThreshold(int value) Sets the threshold above which a warning is given for excessive compaction.
void	setDefaults() Initializes the Health Center preferences to their default values.
void	setHighOccupancyThreshold(int value) Sets the threshold above which a warning is given for high occupancy.
void	setLowOccupancyThreshold(int value) Sets the threshold below which a warning is given for low occupancy.
void	setPauseLengthThreshold(int ms) Sets the threshold above which a warning is given for long pauses.
void	setSystemGCPercentageThreshold(int value) Sets the threshold above which a warning is given for excessive system garbage collections.

Methods inherited from class java.lang.Object

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

Constructor Detail

GCPreferences

public GCPreferences()

Initializes the default set of preferences.

Method Detail

getLowOccupancyThreshold

public int getLowOccupancyThreshold()

Gets the threshold below which a warning is given for low occupancy.

Returns:

the lower threshold, as a percentage of used heap.

getHighOccupancyThreshold

public int getHighOccupancyThreshold()

Gets the threshold above which a warning is given for high occupancy.

Returns:

the upper threshold, as a percentage of used heap.

getPauseLengthThreshold

public int getPauseLengthThreshold()

Gets the threshold above which a warning is given for long pauses.

Returns:

the pause length threshold, in milliseconds.

getCompactionPercentageThreshold

public int getCompactionPercentageThreshold()

Gets the threshold above which a warning is given for excessive compaction.

Returns:

the compaction threshold, as a percentage of garbage collections.

getSystemGCPercentageThreshold

public int getSystemGCPercentageThreshold()

Gets the threshold above which a warning is given for excessive system garbage collections.

Returns:

the system garbage collection threshold, as a percentage of garbage collections.

setLowOccupancyThreshold

public void setLowOccupancyThreshold(int value)

Sets the threshold below which a warning is given for low occupancy.

Parameters:

value - the lower threshold, as a percentage of used heap.

setHighOccupancyThreshold

public void setHighOccupancyThreshold(int value)

Sets the threshold above which a warning is given for high occupancy.

Parameters:

value - the upper threshold, as a percentage of used heap.

setPauseLengthThreshold

public void setPauseLengthThreshold(int ms)

Sets the threshold above which a warning is given for long pauses.

Parameters:

ms - the pause length threshold, in milliseconds.

setCompactionPercentageThreshold

public void setCompactionPercentageThreshold(int value)

Sets the threshold above which a warning is given for excessive compaction.

Parameters:

value - the compaction threshold, as a percentage of garbage collections.

setSystemGCPercentageThreshold

public void setSystemGCPercentageThreshold(int value)

Sets the threshold above which a warning is given for excessive system garbage collections.

Parameters:

value - the system garbage collection threshold, as a percentage of garbage collections.

setDefaults

public void setDefaults()

Initializes the Health Center preferences to their default values.