com.neeve.server.mon
Interface ISrvMonSysGCStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonSysGCStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonSysGCStats
extends IRogValidatable

Groups together stats related to the JVM garbage collections.

Method Summary

void	addCollectorsStats(SrvMonSysGCCollectorStats val) Adds the provided value to the list of 'collectorsStats' values.
void	clearCollectorsStats() Clears the value of 'collectorsStats' Field Description The list of garbage collections that have occurred.
SrvMonSysGCCollectorStats[]	getCollectorsStats() Gets the value of 'collectorsStats' If the field is not set this method will return null.
SrvMonSysGCCollectorStats[]	getCollectorsStatsEmptyIfNull() Gets the value of 'collectorsStats' or an empty array if the value is null or not set.
XIterator<SrvMonSysGCCollectorStats>	getCollectorsStatsIterator() Gets the value of 'collectorsStats' as iterator of values.
void	lendCollectorsStats(SrvMonSysGCCollectorStats val) Adds the provided value to the list of 'collectorsStats' values and acquires a reference to it.
void	lendCollectorsStats(SrvMonSysGCCollectorStats[] val) Lends the value of 'collectorsStats' Field Description The list of garbage collections that have occurred.
void	lendCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val) Sets the value of 'collectorsStats' by lending the values from the provided iterator.
void	setCollectorsStats(SrvMonSysGCCollectorStats[] val) Sets the value of 'collectorsStats' Field Description The list of garbage collections that have occurred.
void	setCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val) Sets the value of 'collectorsStats' using the values from the provided iterator.
SrvMonSysGCCollectorStats[]	takeCollectorsStats() Takes the value of 'collectorsStats' Field Description The list of garbage collections that have occurred.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCollectorsStats

void setCollectorsStats(SrvMonSysGCCollectorStats[] val)

Sets the value of 'collectorsStats'

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Parameters:

val - The value to set.

setCollectorsStatsFrom

void setCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)

Sets the value of 'collectorsStats' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

NOTE:
Passing a null or empty list has the same affect as calling setCollectorsStats(SrvMonSysGCCollectorStats[]) with a value of null.

Parameters:

val - the values to set.

lendCollectorsStatsFrom

void lendCollectorsStatsFrom(XIterator<SrvMonSysGCCollectorStats> val)

Sets the value of 'collectorsStats' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

NOTE:
Passing a null or empty list has the same affect as calling setCollectorsStats(SrvMonSysGCCollectorStats[]) with a value of null.

Parameters:

val - the values to set.

addCollectorsStats

void addCollectorsStats(SrvMonSysGCCollectorStats val)

Adds the provided value to the list of 'collectorsStats' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Parameters:

val - the value to add.

lendCollectorsStats

void lendCollectorsStats(SrvMonSysGCCollectorStats val)

Adds the provided value to the list of 'collectorsStats' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectorsStats' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Parameters:

val - the value to add.

getCollectorsStatsIterator

XIterator<SrvMonSysGCCollectorStats> getCollectorsStatsIterator()

Gets the value of 'collectorsStats' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Returns:

An iterator containing this field values.

lendCollectorsStats

void lendCollectorsStats(SrvMonSysGCCollectorStats[] val)

Lends the value of 'collectorsStats'

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Parameters:

val - the value to 'lend' to lend.

getCollectorsStats

SrvMonSysGCCollectorStats[] getCollectorsStats()

Gets the value of 'collectorsStats'

If the field is not set this method will return null.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Returns:

The list of garbage collections that have occurred. If the field is not set this method will return null.

getCollectorsStatsEmptyIfNull

SrvMonSysGCCollectorStats[] getCollectorsStatsEmptyIfNull()

Gets the value of 'collectorsStats' or an empty array if the value is null or not set.

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

Returns:

The list of garbage collections that have occurred. or an empty array if null if not set.

See Also:

getCollectorsStats()

takeCollectorsStats

SrvMonSysGCCollectorStats[] takeCollectorsStats()

Takes the value of 'collectorsStats'

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

NOTE:
A nested entity reference returned by getCollectorsStats() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Returns:

a 'taken' reference to the field or null if the field is not set.

clearCollectorsStats

void clearCollectorsStats()

Clears the value of 'collectorsStats'

Field Description

The list of garbage collections that have occurred.

This list will include the most recent collections that have occurred since the last heartbeat, but may also include historical garbage collections as well. The collection count field of each collection can be used to determine if two heartbeats duplicate information about garbage collections.

See Also:

setCollectorsStats(SrvMonSysGCCollectorStats[])