com.neeve.server.mon

Interface ISrvMonSysGCCollectorStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysGCCollectorStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonSysGCCollectorStats
extends IRogValidatable

Holds stats for a garbage collector.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
collectionCount	Long	1	The total number of collections that have occurred. A value -1 indicates that the collection count is undefined for this collector.
collectionTime	Long	2	The approximate accumulated collection elapsed time in milliseconds. A value of -1 indicates that the collection elapsed time is undefined for this collector. The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.
collectorName	String	3	The name of the collector that performed the gc.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCollectionCount() Clears the value of 'collectionCount'.
void	clearCollectionTime() Clears the value of 'collectionTime'.
void	clearCollectorName() Clears the value of 'collectorName'.
long	getCollectionCount() Gets the value of 'collectionCount'.
long	getCollectionTime() Gets the value of 'collectionTime'.
String	getCollectorName() Gets the value of 'collectorName'.
<T extends XString> T	getCollectorNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getCollectorNameTo(XString val) Copies the value of 'collectorName' into the provided XString.
XString	getCollectorNameUnsafe() Gets the raw value of 'collectorName'.
boolean	hasCollectionCount() Checks for the presence of 'collectionCount'.
boolean	hasCollectionTime() Checks for the presence of 'collectionTime'.
boolean	hasCollectorName() Checks for the presence of 'collectorName'.
void	lendCollectorName(XString val) Lends the value of 'collectorName' to this object.
void	setCollectionCount(long val) Sets the value of 'collectionCount'.
void	setCollectionTime(long val) Sets the value of 'collectionTime'.
void	setCollectorName(String val) Sets the value of 'collectorName'.
void	setCollectorNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setCollectorNameFrom(XString val) Copies the provided XString value into this object's 'collectorName'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCollectionCount

void setCollectionCount(long val)

Sets the value of 'collectionCount'.

Field Description

The total number of collections that have occurred.

A value -1 indicates that the collection count is undefined for this collector.

Parameters:

val - The value to set.

getCollectionCount

long getCollectionCount()

Gets the value of 'collectionCount'.

Field Description

The total number of collections that have occurred.

A value -1 indicates that the collection count is undefined for this collector.

Returns:

The total number of collections that have occurred.

clearCollectionCount

void clearCollectionCount()

Clears the value of 'collectionCount'.

Field Description

The total number of collections that have occurred.

A value -1 indicates that the collection count is undefined for this collector.

See Also:

setCollectionCount(long)

hasCollectionCount

boolean hasCollectionCount()

Checks for the presence of 'collectionCount'.

Field Description

The total number of collections that have occurred.

A value -1 indicates that the collection count is undefined for this collector.

See Also:

getCollectionCount()

setCollectionTime

void setCollectionTime(long val)

Sets the value of 'collectionTime'.

Field Description

The approximate accumulated collection elapsed time in milliseconds.

A value of -1 indicates that the collection elapsed time is undefined for this collector. The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.

Parameters:

val - The value to set.

getCollectionTime

long getCollectionTime()

Gets the value of 'collectionTime'.

Field Description

The approximate accumulated collection elapsed time in milliseconds.

A value of -1 indicates that the collection elapsed time is undefined for this collector. The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.

Returns:

The approximate accumulated collection elapsed time in milliseconds.

clearCollectionTime

void clearCollectionTime()

Clears the value of 'collectionTime'.

Field Description

The approximate accumulated collection elapsed time in milliseconds.

A value of -1 indicates that the collection elapsed time is undefined for this collector. The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.

See Also:

setCollectionTime(long)

hasCollectionTime

boolean hasCollectionTime()

Checks for the presence of 'collectionTime'.

Field Description

The approximate accumulated collection elapsed time in milliseconds.

A value of -1 indicates that the collection elapsed time is undefined for this collector. The Java virtual machine implementation may use a high resolution timer to measure the elapsed time. This method may return the same value even if the collection count has been incremented if the collection elapsed time is very short.

See Also:

getCollectionTime()

setCollectorName

void setCollectorName(String val)

Sets the value of 'collectorName'.

Field Description

The name of the collector that performed the gc.

Parameters:

val - The value to set.

getCollectorName

String getCollectorName()

Gets the value of 'collectorName'.

Field Description

The name of the collector that performed the gc.

Returns:

The name of the collector that performed the gc.

lendCollectorName

void lendCollectorName(XString val)

Lends the value of 'collectorName' to this object.

This method is equivalent to setCollectorName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The name of the collector that performed the gc.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setCollectorNameFrom

void setCollectorNameFrom(long val)

Sets the value of this String field to the given numeric value.

Field Description

The name of the collector that performed the gc.

NOTE:
This is the same as calling setCollectorName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getCollectorNameTo

<T extends XString> T getCollectorNameTo(XString.Factory<T> factory)

Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the collector that performed the gc.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setCollectorNameFrom

void setCollectorNameFrom(XString val)

Copies the provided XString value into this object's 'collectorName'.

Field Description

The name of the collector that performed the gc.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setCollectorName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getCollectorNameTo

void getCollectorNameTo(XString val)

Copies the value of 'collectorName' into the provided XString.

Field Description

The name of the collector that performed the gc.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getCollectorName() bec because it can avoid decoding the value into an String.

See Also:

getCollectorName()

getCollectorNameUnsafe

XString getCollectorNameUnsafe()

Gets the raw value of 'collectorName'.

Field Description

The name of the collector that performed the gc.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getCollectorName()

clearCollectorName

void clearCollectorName()

Clears the value of 'collectorName'.

Field Description

The name of the collector that performed the gc.

See Also:

setCollectorName(String)

hasCollectorName

boolean hasCollectorName()

Checks for the presence of 'collectorName'.

Field Description

The name of the collector that performed the gc.

See Also:

getCollectorName()