com.neeve.server.mon

Interface ISrvMonUserStats

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonUserStats

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Aug 19 03:49:17 UTC 2026")
 @AdmGenerated(compatLevel="5.0.0",
              admVersion="Unknown Version",
              date="8/19/26 3:49 AM",
              buildInfo="nvx-rumi-server-4.0.652 (Rumi ADM Maven Plugin)")
public interface ISrvMonUserStats
extends IRogValidatable

Groups together the collections of application (User) defined counter and latencies statistics.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonHeartbeatFactory

ADM Field Summary

Field	Type	Id	Description
counters	SrvMonUserCounterStat[]	1	Application Counter Stats.
gauges	SrvMonUserGaugeStat[]	3	Application Gauge Stats.
series	SrvMonUserSeriesStat[]	2	Application Series Stats.

Method Summary

Modifier and Type	Method and Description
void	addCounters(SrvMonUserCounterStat val) Adds the provided value to the list of 'counters' values.
void	addGauges(SrvMonUserGaugeStat val) Adds the provided value to the list of 'gauges' values.
void	addSeries(SrvMonUserSeriesStat val) Adds the provided value to the list of 'series' values.
void	clearCounters() Clears the value of 'counters'.
void	clearCountersAt(int index) Removes and disposes the element of 'counters' at a specified index.
void	clearGauges() Clears the value of 'gauges'.
void	clearGaugesAt(int index) Removes and disposes the element of 'gauges' at a specified index.
void	clearSeries() Clears the value of 'series'.
void	clearSeriesAt(int index) Removes and disposes the element of 'series' at a specified index.
SrvMonUserCounterStat[]	getCounters() Gets the value of 'counters'.
SrvMonUserCounterStat	getCountersAt(int index) Gets the element of 'counters' at a specified index.
int	getCountersCount() Gets number of elements in 'counters'.
SrvMonUserCounterStat[]	getCountersEmptyIfNull() Gets the value of 'counters' or an empty array if the value is null or not set.
XIterator<SrvMonUserCounterStat>	getCountersIterator() Gets the value of 'counters' as iterator of values.
SrvMonUserGaugeStat[]	getGauges() Gets the value of 'gauges'.
SrvMonUserGaugeStat	getGaugesAt(int index) Gets the element of 'gauges' at a specified index.
int	getGaugesCount() Gets number of elements in 'gauges'.
SrvMonUserGaugeStat[]	getGaugesEmptyIfNull() Gets the value of 'gauges' or an empty array if the value is null or not set.
XIterator<SrvMonUserGaugeStat>	getGaugesIterator() Gets the value of 'gauges' as iterator of values.
SrvMonUserSeriesStat[]	getSeries() Gets the value of 'series'.
SrvMonUserSeriesStat	getSeriesAt(int index) Gets the element of 'series' at a specified index.
int	getSeriesCount() Gets number of elements in 'series'.
SrvMonUserSeriesStat[]	getSeriesEmptyIfNull() Gets the value of 'series' or an empty array if the value is null or not set.
XIterator<SrvMonUserSeriesStat>	getSeriesIterator() Gets the value of 'series' as iterator of values.
void	lendCounters(SrvMonUserCounterStat val) Adds the provided value to the list of 'counters' values and acquires a reference to it.
void	lendCounters(SrvMonUserCounterStat[] val) Lends the value of 'counters'.
void	lendCountersAt(int index, SrvMonUserCounterStat val) Replaces, in place, the element of 'counters' at a specified index, 'lending' the value.
void	lendCountersFrom(XIterator<SrvMonUserCounterStat> val) Sets the value of 'counters' by lending the values from the provided iterator.
void	lendGauges(SrvMonUserGaugeStat val) Adds the provided value to the list of 'gauges' values and acquires a reference to it.
void	lendGauges(SrvMonUserGaugeStat[] val) Lends the value of 'gauges'.
void	lendGaugesAt(int index, SrvMonUserGaugeStat val) Replaces, in place, the element of 'gauges' at a specified index, 'lending' the value.
void	lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val) Sets the value of 'gauges' by lending the values from the provided iterator.
void	lendSeries(SrvMonUserSeriesStat val) Adds the provided value to the list of 'series' values and acquires a reference to it.
void	lendSeries(SrvMonUserSeriesStat[] val) Lends the value of 'series'.
void	lendSeriesAt(int index, SrvMonUserSeriesStat val) Replaces, in place, the element of 'series' at a specified index, 'lending' the value.
void	lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val) Sets the value of 'series' by lending the values from the provided iterator.
void	setCounters(SrvMonUserCounterStat[] val) Sets the value of 'counters'.
void	setCountersAt(int index, SrvMonUserCounterStat val) Replaces, in place, the element of 'counters' at a specified index.
void	setCountersFrom(XIterator<SrvMonUserCounterStat> val) Sets the value of 'counters' using the values from the provided iterator.
void	setGauges(SrvMonUserGaugeStat[] val) Sets the value of 'gauges'.
void	setGaugesAt(int index, SrvMonUserGaugeStat val) Replaces, in place, the element of 'gauges' at a specified index.
void	setGaugesFrom(XIterator<SrvMonUserGaugeStat> val) Sets the value of 'gauges' using the values from the provided iterator.
void	setSeries(SrvMonUserSeriesStat[] val) Sets the value of 'series'.
void	setSeriesAt(int index, SrvMonUserSeriesStat val) Replaces, in place, the element of 'series' at a specified index.
void	setSeriesFrom(XIterator<SrvMonUserSeriesStat> val) Sets the value of 'series' using the values from the provided iterator.
SrvMonUserCounterStat[]	takeCounters() Takes the value of 'counters'.
SrvMonUserGaugeStat[]	takeGauges() Takes the value of 'gauges'.
SrvMonUserSeriesStat[]	takeSeries() Takes the value of 'series'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCounters

void setCounters(SrvMonUserCounterStat[] val)

Sets the value of 'counters'.

Field Description

Application Counter Stats.

Parameters:

val - The value to set.

setCountersAt

void setCountersAt(int index,
                   SrvMonUserCounterStat val)

Replaces, in place, the element of 'counters' at a specified index.

Field Description

Application Counter Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. Ownership of the supplied value is transferred to this object (as with add). To acquire rather than transfer, use lendCountersAt(int, SrvMonUserCounterStat).

Parameters:

index - The index of the element to replace.

val - The replacement element (must not be null; use clearCountersAt(int) to remove).

setCountersFrom

void setCountersFrom(XIterator<SrvMonUserCounterStat> val)

Sets the value of 'counters' 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 'counters' accessor can copy the values without iteration.

Field Description

Application Counter Stats.

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

Parameters:

val - the values to set.

lendCountersFrom

void lendCountersFrom(XIterator<SrvMonUserCounterStat> val)

Sets the value of 'counters' 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 'counters' accessor can copy the values without iteration.

Field Description

Application Counter Stats.

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

Parameters:

val - the values to set.

lendCounters

void lendCounters(SrvMonUserCounterStat val)

Adds the provided value to the list of 'counters' 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 'counters' 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

Application Counter Stats.

Parameters:

val - the value to add.

lendCounters

void lendCounters(SrvMonUserCounterStat[] val)

Lends the value of 'counters'.

Field Description

Application Counter Stats.

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.

lendCountersAt

void lendCountersAt(int index,
                    SrvMonUserCounterStat val)

Replaces, in place, the element of 'counters' at a specified index, 'lending' the value.

Field Description

Application Counter Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. The supplied value is 'lent' (acquired), so the caller retains ownership; see lendCounters(SrvMonUserCounterStat[]) for the semantics of lending.

Parameters:

index - The index of the element to replace.

val - The replacement element to 'lend' (must not be null; use clearCountersAt(int) to remove).

addCounters

void addCounters(SrvMonUserCounterStat val)

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

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'counters' 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

Application Counter Stats.

Parameters:

val - the value to add.

getCountersCount

int getCountersCount()

Gets number of elements in 'counters'.

Field Description

Application Counter Stats.

Returns:

The number of elements.

getCountersIterator

XIterator<SrvMonUserCounterStat> getCountersIterator()

Gets the value of 'counters' 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 it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

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

Application Counter Stats.

Returns:

An iterator containing this field values.

getCounters

SrvMonUserCounterStat[] getCounters()

Gets the value of 'counters'.

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

Field Description

Application Counter Stats.

Returns:

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

getCountersEmptyIfNull

SrvMonUserCounterStat[] getCountersEmptyIfNull()

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

Field Description

Application Counter Stats.

Returns:

Application Counter Stats. or an empty array if null if not set.

See Also:

getCounters()

getCountersAt

SrvMonUserCounterStat getCountersAt(int index)

Gets the element of 'counters' at a specified index.

Field Description

Application Counter Stats.

Parameters:

index - The index for which the element is to be returned.

Returns:

The element.

takeCounters

SrvMonUserCounterStat[] takeCounters()

Takes the value of 'counters'.

Field Description

Application Counter Stats.

NOTE:
A nested entity reference returned by getCounters() 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.

clearCountersAt

void clearCountersAt(int index)

Removes and disposes the element of 'counters' at a specified index.

Field Description

Application Counter Stats.

This is a gap-closing removal: elements after the index shift down by one and the field size decreases by one. Only the removed element is disposed; all other elements are left untouched.

Parameters:

index - The index of the element to remove.

clearCounters

void clearCounters()

Clears the value of 'counters'.

Field Description

Application Counter Stats.

See Also:

setCounters(SrvMonUserCounterStat[])

setSeries

void setSeries(SrvMonUserSeriesStat[] val)

Sets the value of 'series'.

Field Description

Application Series Stats.

Parameters:

val - The value to set.

setSeriesAt

void setSeriesAt(int index,
                 SrvMonUserSeriesStat val)

Replaces, in place, the element of 'series' at a specified index.

Field Description

Application Series Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. Ownership of the supplied value is transferred to this object (as with add). To acquire rather than transfer, use lendSeriesAt(int, SrvMonUserSeriesStat).

Parameters:

index - The index of the element to replace.

val - The replacement element (must not be null; use clearSeriesAt(int) to remove).

setSeriesFrom

void setSeriesFrom(XIterator<SrvMonUserSeriesStat> val)

Sets the value of 'series' 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 'series' accessor can copy the values without iteration.

Field Description

Application Series Stats.

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

Parameters:

val - the values to set.

lendSeriesFrom

void lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val)

Sets the value of 'series' 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 'series' accessor can copy the values without iteration.

Field Description

Application Series Stats.

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

Parameters:

val - the values to set.

lendSeries

void lendSeries(SrvMonUserSeriesStat val)

Adds the provided value to the list of 'series' 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 'series' 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

Application Series Stats.

Parameters:

val - the value to add.

lendSeries

void lendSeries(SrvMonUserSeriesStat[] val)

Lends the value of 'series'.

Field Description

Application Series Stats.

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.

lendSeriesAt

void lendSeriesAt(int index,
                  SrvMonUserSeriesStat val)

Replaces, in place, the element of 'series' at a specified index, 'lending' the value.

Field Description

Application Series Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. The supplied value is 'lent' (acquired), so the caller retains ownership; see lendSeries(SrvMonUserSeriesStat[]) for the semantics of lending.

Parameters:

index - The index of the element to replace.

val - The replacement element to 'lend' (must not be null; use clearSeriesAt(int) to remove).

addSeries

void addSeries(SrvMonUserSeriesStat val)

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

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'series' 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

Application Series Stats.

Parameters:

val - the value to add.

getSeriesCount

int getSeriesCount()

Gets number of elements in 'series'.

Field Description

Application Series Stats.

Returns:

The number of elements.

getSeriesIterator

XIterator<SrvMonUserSeriesStat> getSeriesIterator()

Gets the value of 'series' 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 it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

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

Application Series Stats.

Returns:

An iterator containing this field values.

getSeries

SrvMonUserSeriesStat[] getSeries()

Gets the value of 'series'.

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

Field Description

Application Series Stats.

Returns:

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

getSeriesEmptyIfNull

SrvMonUserSeriesStat[] getSeriesEmptyIfNull()

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

Field Description

Application Series Stats.

Returns:

Application Series Stats. or an empty array if null if not set.

See Also:

getSeries()

getSeriesAt

SrvMonUserSeriesStat getSeriesAt(int index)

Gets the element of 'series' at a specified index.

Field Description

Application Series Stats.

Parameters:

index - The index for which the element is to be returned.

Returns:

The element.

takeSeries

SrvMonUserSeriesStat[] takeSeries()

Takes the value of 'series'.

Field Description

Application Series Stats.

NOTE:
A nested entity reference returned by getSeries() 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.

clearSeriesAt

void clearSeriesAt(int index)

Removes and disposes the element of 'series' at a specified index.

Field Description

Application Series Stats.

This is a gap-closing removal: elements after the index shift down by one and the field size decreases by one. Only the removed element is disposed; all other elements are left untouched.

Parameters:

index - The index of the element to remove.

clearSeries

void clearSeries()

Clears the value of 'series'.

Field Description

Application Series Stats.

See Also:

setSeries(SrvMonUserSeriesStat[])

setGauges

void setGauges(SrvMonUserGaugeStat[] val)

Sets the value of 'gauges'.

Field Description

Application Gauge Stats.

Parameters:

val - The value to set.

setGaugesAt

void setGaugesAt(int index,
                 SrvMonUserGaugeStat val)

Replaces, in place, the element of 'gauges' at a specified index.

Field Description

Application Gauge Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. Ownership of the supplied value is transferred to this object (as with add). To acquire rather than transfer, use lendGaugesAt(int, SrvMonUserGaugeStat).

Parameters:

index - The index of the element to replace.

val - The replacement element (must not be null; use clearGaugesAt(int) to remove).

setGaugesFrom

void setGaugesFrom(XIterator<SrvMonUserGaugeStat> val)

Sets the value of 'gauges' 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 'gauges' accessor can copy the values without iteration.

Field Description

Application Gauge Stats.

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

Parameters:

val - the values to set.

lendGaugesFrom

void lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val)

Sets the value of 'gauges' 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 'gauges' accessor can copy the values without iteration.

Field Description

Application Gauge Stats.

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

Parameters:

val - the values to set.

lendGauges

void lendGauges(SrvMonUserGaugeStat val)

Adds the provided value to the list of 'gauges' 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 'gauges' 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

Application Gauge Stats.

Parameters:

val - the value to add.

lendGauges

void lendGauges(SrvMonUserGaugeStat[] val)

Lends the value of 'gauges'.

Field Description

Application Gauge Stats.

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.

lendGaugesAt

void lendGaugesAt(int index,
                  SrvMonUserGaugeStat val)

Replaces, in place, the element of 'gauges' at a specified index, 'lending' the value.

Field Description

Application Gauge Stats.

The element previously at the index is disposed. The order and size of the field are unchanged. The supplied value is 'lent' (acquired), so the caller retains ownership; see lendGauges(SrvMonUserGaugeStat[]) for the semantics of lending.

Parameters:

index - The index of the element to replace.

val - The replacement element to 'lend' (must not be null; use clearGaugesAt(int) to remove).

addGauges

void addGauges(SrvMonUserGaugeStat val)

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

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'gauges' 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

Application Gauge Stats.

Parameters:

val - the value to add.

getGaugesCount

int getGaugesCount()

Gets number of elements in 'gauges'.

Field Description

Application Gauge Stats.

Returns:

The number of elements.

getGaugesIterator

XIterator<SrvMonUserGaugeStat> getGaugesIterator()

Gets the value of 'gauges' 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 it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.

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

Application Gauge Stats.

Returns:

An iterator containing this field values.

getGauges

SrvMonUserGaugeStat[] getGauges()

Gets the value of 'gauges'.

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

Field Description

Application Gauge Stats.

Returns:

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

getGaugesEmptyIfNull

SrvMonUserGaugeStat[] getGaugesEmptyIfNull()

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

Field Description

Application Gauge Stats.

Returns:

Application Gauge Stats. or an empty array if null if not set.

See Also:

getGauges()

getGaugesAt

SrvMonUserGaugeStat getGaugesAt(int index)

Gets the element of 'gauges' at a specified index.

Field Description

Application Gauge Stats.

Parameters:

index - The index for which the element is to be returned.

Returns:

The element.

takeGauges

SrvMonUserGaugeStat[] takeGauges()

Takes the value of 'gauges'.

Field Description

Application Gauge Stats.

NOTE:
A nested entity reference returned by getGauges() 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.

clearGaugesAt

void clearGaugesAt(int index)

Removes and disposes the element of 'gauges' at a specified index.

Field Description

Application Gauge Stats.

This is a gap-closing removal: elements after the index shift down by one and the field size decreases by one. Only the removed element is disposed; all other elements are left untouched.

Parameters:

index - The index of the element to remove.

clearGauges

void clearGauges()

Clears the value of 'gauges'.

Field Description

Application Gauge Stats.

See Also:

setGauges(SrvMonUserGaugeStat[])