@Generated(value="com.neeve.protobuf.adm.ProtobufAdmNodeGenerator", date="Tue Sep 16 04:36:05 UTC 2025") @AdmGenerated(encoding="xbuf", compatLevel="5.0.0", admVersion="Unknown Version", date="9/16/25 4:36 AM", buildInfo="nvx-rumi-server-4.0.595 (Rumi ADM Maven Plugin)") @AdmFactoryInfo(factoryClass=SrvMonHeartbeatFactory.class, vfid=32, ofid=32, typeId=222) public final class SrvMonUserStats extends Object implements ISrvMonUserStats, MessageReflector, com.neeve.query.impl.index.IdxMappable, UtlPool.Item<SrvMonUserStats>, AdmRuntime.BufferSizer
| ADM Type | Embedded Entity |
| Factory | SrvMonHeartbeatFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| counters | SrvMonUserCounterStat[] | 16 | Application Counter Stats. |
| gauges | SrvMonUserGaugeStat[] | 18 | Application Gauge Stats. |
| series | SrvMonUserSeriesStat[] | 17 | Application Series Stats. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonUserStats.Deserializer
The deserializer
|
static class |
SrvMonUserStats.PacketBody
The backing packet type for SrvMonUserStats (used internally for serialization purposes).
|
static class |
SrvMonUserStats.Pojo
The POJO
|
static class |
SrvMonUserStats.Serializer
The serializer
|
| Modifier and Type | Field and Description |
|---|---|
static SrvMonUserStats[] |
EMPTY_ARRAY |
| Modifier and Type | Method and Description |
|---|---|
SrvMonUserStats |
acquire() |
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.
|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target)
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Appends a reflected field value as a string into the given XString.
|
void |
clear() |
void |
clear(boolean disposeMembers) |
void |
clearContent()
Deprecated.
|
void |
clearCounters()
Clears the value of 'counters'.
|
void |
clearGauges()
Clears the value of 'gauges'.
|
void |
clearSeries()
Clears the value of 'series'.
|
Object |
clone()
Creates a clone of this object.
|
SrvMonUserStats |
copy() |
void |
copyInto(SrvMonUserStats copy) |
static SrvMonUserStats |
create() |
SrvMonUserStats |
deserializeFrom(byte[] array,
int offset,
int len) |
SrvMonUserStats |
deserializeFrom(ByteBuffer buffer) |
SrvMonUserStats |
deserializeFrom(IOBuffer buffer,
int offset,
int len) |
SrvMonUserStats |
deserializeFrom(IOElasticBuffer buffer,
int offset,
int len) |
SrvMonUserStats |
deserializeFrom(long addr,
int offset,
int len) |
SrvMonUserStats |
deserializeFrom(PktPacket packet) |
SrvMonUserStats |
deserializeFrom(SrvMonUserStats.Deserializer deserializer) |
SrvMonUserStats |
deserializeFrom(SrvMonUserStats val) |
SrvMonUserStats |
deserializeFromByteArray(byte[] array) |
SrvMonUserStats |
deserializeFromByteBuffer(ByteBuffer buffer) |
SrvMonUserStats |
deserializeFromJson(String json) |
SrvMonUserStats |
deserializeFromNative(long addr,
int offset,
int len)
Deprecated.
|
SrvMonUserStats |
deserializeFromPacket(PktPacket packet) |
SrvMonUserStats |
deserializeFromRawJson(String json) |
SrvMonUserStats.Deserializer |
deserializer() |
SrvMonUserStats.Deserializer |
deserializer(boolean createBuffer) |
void |
dispose() |
void |
disposeDeserializer() |
void |
disposePojo() |
void |
disposePojo(boolean sync) |
void |
disposeSerializedBuffer() |
void |
disposeSerializedBuffer(boolean gcDisposed) |
void |
disposeSerializer() |
long |
ensureCapacity(long addr,
int capacity)
Method invoked by the serializer to ensure there is enough space in the target
buffer to accommodate a field being serialized
|
boolean |
fieldExists(Object message,
String name)
Check if a field of the supplied name exists in a message.
|
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. |
static int |
getCountersFieldId() |
XIterator<SrvMonUserCounterStat> |
getCountersIterator()
Gets the value of 'counters' as iterator of values.
|
static <T> IRogFieldReflector<SrvMonUserStats,T> |
getFieldReflector(String name)
Get a field reflector.
|
static <T> IRogFieldReflector<SrvMonUserStats,T> |
getFieldReflector(String[] pathComponents)
Get a field reflector.
|
XString |
getFieldValueAsRawString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
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. |
static int |
getGaugesFieldId() |
XIterator<SrvMonUserGaugeStat> |
getGaugesIterator()
Gets the value of 'gauges' as iterator of values.
|
int |
getOwnershipCount() |
UtlPool<SrvMonUserStats> |
getPool()
Get a pool item's pool.
|
Object |
getQueryFieldValue(String name)
Gets an indexable value identified by a key.
|
long |
getSerializedBuffer() |
int |
getSerializedBufferCapacity() |
int |
getSerializedBufferLength() |
int |
getSerializeToNativeLength()
Deprecated.
|
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. |
static int |
getSeriesFieldId() |
XIterator<SrvMonUserSeriesStat> |
getSeriesIterator()
Gets the value of 'series' as iterator of values.
|
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list.
|
boolean |
hasDirtyPojo() |
boolean |
hasPojo() |
boolean |
hasSerializedBuffer() |
SrvMonUserStats |
init()
Initialize an item.
|
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
boolean |
isValid()
Tests if this object has any validation errors.
|
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 |
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 |
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 |
lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
Sets the value of 'series' by lending the values from the provided iterator.
|
boolean |
needsSync()
Check if a view needs to be sync'd for reflection.
|
SrvMonUserStats.Pojo |
pojo() |
SrvMonUserStats.Pojo |
pojo(boolean onlyPojos) |
void |
reset() |
void |
reset(boolean disposeMembers) |
SrvMonUserStats.Serializer |
serializer() |
SrvMonUserStats.Serializer |
serializer(int minimumLength) |
SrvMonUserStats.Serializer |
serializer(int length,
boolean autoResizeTargetBuffer) |
int |
serializeTo(byte[] array,
int offset) |
int |
serializeTo(ByteBuffer buffer) |
int |
serializeTo(IOBuffer buffer,
int offset) |
int |
serializeTo(IOElasticBuffer buffer,
int offset) |
int |
serializeTo(long addr,
int offset) |
int |
serializeTo(PktPacket packet) |
int |
serializeTo(SrvMonUserStats.Serializer serializer) |
byte[] |
serializeToByteArray() |
ByteBuffer |
serializeToByteBuffer() |
IOBuffer |
serializeToIOBuffer(boolean useNative) |
String |
serializeToJson() |
int |
serializeToNative(long addr,
int offset)
Deprecated.
|
PktPacket |
serializeToPacket() |
String |
serializeToRawJson() |
void |
setAsReadOnly() |
void |
setCounters(SrvMonUserCounterStat[] val)
Sets the value of 'counters'.
|
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 |
setGaugesFrom(XIterator<SrvMonUserGaugeStat> val)
Sets the value of 'gauges' using the values from the provided iterator.
|
SrvMonUserStats |
setPool(UtlPool<SrvMonUserStats> pool)
Set a pool item's pool.
|
void |
setSeries(SrvMonUserSeriesStat[] val)
Sets the value of 'series'.
|
void |
setSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
Sets the value of 'series' using the values from the provided iterator.
|
void |
sync() |
SrvMonUserCounterStat[] |
takeCounters()
Takes the value of 'counters'.
|
SrvMonUserGaugeStat[] |
takeGauges()
Takes the value of 'gauges'.
|
SrvMonUserSeriesStat[] |
takeSeries()
Takes the value of 'series'.
|
String |
toString() |
SrvMonUserStats |
wrap(IOBuffer buffer,
int len) |
public static final SrvMonUserStats[] EMPTY_ARRAY
public static SrvMonUserStats create()
public final boolean hasSerializedBuffer()
public final long getSerializedBuffer()
public final int getSerializedBufferCapacity()
public final int getSerializedBufferLength()
@Deprecated public final int getSerializeToNativeLength()
public final SrvMonUserStats.Serializer serializer(int length, boolean autoResizeTargetBuffer)
public final SrvMonUserStats.Serializer serializer(int minimumLength)
public final SrvMonUserStats.Serializer serializer()
public final long ensureCapacity(long addr,
int capacity)
AdmRuntime.BufferSizerensureCapacity in interface AdmRuntime.BufferSizeraddr - The native address of the target buffercapacity - The required capacity of the bufferThis method is invoked by a serializer each time it serializes a field or part of a field to the target buffer to ensure that the target buffer has the desired capacity to hold the data being added.
public final SrvMonUserStats.Deserializer deserializer(boolean createBuffer)
public final SrvMonUserStats.Deserializer deserializer()
public final boolean hasPojo()
public final boolean hasDirtyPojo()
public final SrvMonUserStats.Pojo pojo(boolean onlyPojos)
public final SrvMonUserStats.Pojo pojo()
public final void disposeSerializedBuffer(boolean gcDisposed)
public final void disposeSerializedBuffer()
public final void disposeSerializer()
public final void disposeDeserializer()
public final void disposePojo(boolean sync)
public final void disposePojo()
public final void clear(boolean disposeMembers)
public final void clear()
@Deprecated public final void clearContent()
public final void reset(boolean disposeMembers)
public final void reset()
public final String serializeToRawJson()
public final int serializeTo(SrvMonUserStats.Serializer serializer)
public final void sync()
public final byte[] serializeToByteArray()
public final int serializeTo(byte[] array,
int offset)
public final ByteBuffer serializeToByteBuffer()
public final int serializeTo(ByteBuffer buffer)
public final IOBuffer serializeToIOBuffer(boolean useNative)
public final int serializeTo(IOBuffer buffer, int offset)
public final int serializeTo(IOElasticBuffer buffer, int offset)
public final PktPacket serializeToPacket()
public final int serializeTo(PktPacket packet)
public final int serializeTo(long addr,
int offset)
@Deprecated public final int serializeToNative(long addr, int offset)
public final String serializeToJson()
public final SrvMonUserStats deserializeFromRawJson(String json)
public final SrvMonUserStats deserializeFrom(SrvMonUserStats.Deserializer deserializer)
public final SrvMonUserStats deserializeFrom(SrvMonUserStats val)
public final SrvMonUserStats wrap(IOBuffer buffer, int len)
public final SrvMonUserStats deserializeFromByteArray(byte[] array)
public final SrvMonUserStats deserializeFrom(byte[] array, int offset, int len)
public final SrvMonUserStats deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonUserStats deserializeFrom(ByteBuffer buffer)
public final SrvMonUserStats deserializeFrom(IOBuffer buffer, int offset, int len)
public final SrvMonUserStats deserializeFrom(IOElasticBuffer buffer, int offset, int len)
public final SrvMonUserStats deserializeFromPacket(PktPacket packet)
public final SrvMonUserStats deserializeFrom(PktPacket packet)
public final SrvMonUserStats deserializeFrom(long addr, int offset, int len)
@Deprecated public final SrvMonUserStats deserializeFromNative(long addr, int offset, int len)
public final SrvMonUserStats deserializeFromJson(String json)
public final void copyInto(SrvMonUserStats copy)
public final SrvMonUserStats copy()
public boolean needsSync()
MessageReflectorneedsSync in interface MessageReflectorpublic final boolean fieldExists(Object message, String name)
MessageReflectorfieldExists in interface MessageReflectormessage - The message to check in.name - The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflectorisFieldReflectable in interface MessageReflectormessage - The message to check in.name - The field to check for.public final String getFieldValueAsString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final String getFieldValueAsString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final boolean appendFieldValueTo(Object message, String name, XString target)
MessageReflectorIf the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
appendFieldValueTo in interface MessageReflectormessage - the node on which to reflect (which need not be this object).name - the bean path to the field.target - The target XString into which to append the result.public final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
MessageReflectorIf the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
appendFieldValueTo in interface MessageReflectornode - the node on which to reflect (which need not be this object).pathComponents - the bean path to the field on the provided object split by its '.' separated components.target - The target XString into which to append the result.public final void setAsReadOnly()
public static final int getCountersFieldId()
public final void setCounters(SrvMonUserCounterStat[] val)
ISrvMonUserStatssetCounters in interface ISrvMonUserStatsval - The value to set.public final void lendCounters(SrvMonUserCounterStat[] val)
ISrvMonUserStats
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.
lendCounters in interface ISrvMonUserStatsval - the value to 'lend' to lend.public final void setCountersFrom(XIterator<SrvMonUserCounterStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setCounters(SrvMonUserCounterStat[]) with
a value of null.
setCountersFrom in interface ISrvMonUserStatsval - the values to set.public final void lendCountersFrom(XIterator<SrvMonUserCounterStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setCounters(SrvMonUserCounterStat[]) with
a value of null.
lendCountersFrom in interface ISrvMonUserStatsval - the values to set.public final void addCounters(SrvMonUserCounterStat val)
ISrvMonUserStatsThis 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.
addCounters in interface ISrvMonUserStatsval - the value to add.public final void lendCounters(SrvMonUserCounterStat val)
ISrvMonUserStatsLending 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.
lendCounters in interface ISrvMonUserStatsval - the value to add.public final SrvMonUserCounterStat[] getCounters()
ISrvMonUserStats
If the field is not set this method will return null.
getCounters in interface ISrvMonUserStatsnull.public final SrvMonUserCounterStat[] getCountersEmptyIfNull()
ISrvMonUserStatsnull or not set.
getCountersEmptyIfNull in interface ISrvMonUserStatsnull if not set.ISrvMonUserStats.getCounters()public final int getCountersCount()
ISrvMonUserStatsgetCountersCount in interface ISrvMonUserStatspublic final SrvMonUserCounterStat getCountersAt(int index)
ISrvMonUserStatsgetCountersAt in interface ISrvMonUserStatsindex - The index for which the element is to be returned.public final XIterator<SrvMonUserCounterStat> getCountersIterator()
ISrvMonUserStatsThis 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
getCountersIterator in interface ISrvMonUserStatspublic final SrvMonUserCounterStat[] takeCounters()
ISrvMonUserStats
NOTE:
A nested entity reference returned by ISrvMonUserStats.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.
takeCounters in interface ISrvMonUserStatsnull if the field is not set.public final void clearCounters()
ISrvMonUserStatsclearCounters in interface ISrvMonUserStatsISrvMonUserStats.setCounters(SrvMonUserCounterStat[])public static final int getSeriesFieldId()
public final void setSeries(SrvMonUserSeriesStat[] val)
ISrvMonUserStatssetSeries in interface ISrvMonUserStatsval - The value to set.public final void lendSeries(SrvMonUserSeriesStat[] val)
ISrvMonUserStats
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.
lendSeries in interface ISrvMonUserStatsval - the value to 'lend' to lend.public final void setSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setSeries(SrvMonUserSeriesStat[]) with
a value of null.
setSeriesFrom in interface ISrvMonUserStatsval - the values to set.public final void lendSeriesFrom(XIterator<SrvMonUserSeriesStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setSeries(SrvMonUserSeriesStat[]) with
a value of null.
lendSeriesFrom in interface ISrvMonUserStatsval - the values to set.public final void addSeries(SrvMonUserSeriesStat val)
ISrvMonUserStatsThis 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.
addSeries in interface ISrvMonUserStatsval - the value to add.public final void lendSeries(SrvMonUserSeriesStat val)
ISrvMonUserStatsLending 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.
lendSeries in interface ISrvMonUserStatsval - the value to add.public final SrvMonUserSeriesStat[] getSeries()
ISrvMonUserStats
If the field is not set this method will return null.
getSeries in interface ISrvMonUserStatsnull.public final SrvMonUserSeriesStat[] getSeriesEmptyIfNull()
ISrvMonUserStatsnull or not set.
getSeriesEmptyIfNull in interface ISrvMonUserStatsnull if not set.ISrvMonUserStats.getSeries()public final int getSeriesCount()
ISrvMonUserStatsgetSeriesCount in interface ISrvMonUserStatspublic final SrvMonUserSeriesStat getSeriesAt(int index)
ISrvMonUserStatsgetSeriesAt in interface ISrvMonUserStatsindex - The index for which the element is to be returned.public final XIterator<SrvMonUserSeriesStat> getSeriesIterator()
ISrvMonUserStatsThis 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
getSeriesIterator in interface ISrvMonUserStatspublic final SrvMonUserSeriesStat[] takeSeries()
ISrvMonUserStats
NOTE:
A nested entity reference returned by ISrvMonUserStats.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.
takeSeries in interface ISrvMonUserStatsnull if the field is not set.public final void clearSeries()
ISrvMonUserStatsclearSeries in interface ISrvMonUserStatsISrvMonUserStats.setSeries(SrvMonUserSeriesStat[])public static final int getGaugesFieldId()
public final void setGauges(SrvMonUserGaugeStat[] val)
ISrvMonUserStatssetGauges in interface ISrvMonUserStatsval - The value to set.public final void lendGauges(SrvMonUserGaugeStat[] val)
ISrvMonUserStats
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.
lendGauges in interface ISrvMonUserStatsval - the value to 'lend' to lend.public final void setGaugesFrom(XIterator<SrvMonUserGaugeStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setGauges(SrvMonUserGaugeStat[]) with
a value of null.
setGaugesFrom in interface ISrvMonUserStatsval - the values to set.public final void lendGaugesFrom(XIterator<SrvMonUserGaugeStat> val)
ISrvMonUserStats
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.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonUserStats.setGauges(SrvMonUserGaugeStat[]) with
a value of null.
lendGaugesFrom in interface ISrvMonUserStatsval - the values to set.public final void addGauges(SrvMonUserGaugeStat val)
ISrvMonUserStatsThis 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.
addGauges in interface ISrvMonUserStatsval - the value to add.public final void lendGauges(SrvMonUserGaugeStat val)
ISrvMonUserStatsLending 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.
lendGauges in interface ISrvMonUserStatsval - the value to add.public final SrvMonUserGaugeStat[] getGauges()
ISrvMonUserStats
If the field is not set this method will return null.
getGauges in interface ISrvMonUserStatsnull.public final SrvMonUserGaugeStat[] getGaugesEmptyIfNull()
ISrvMonUserStatsnull or not set.
getGaugesEmptyIfNull in interface ISrvMonUserStatsnull if not set.ISrvMonUserStats.getGauges()public final int getGaugesCount()
ISrvMonUserStatsgetGaugesCount in interface ISrvMonUserStatspublic final SrvMonUserGaugeStat getGaugesAt(int index)
ISrvMonUserStatsgetGaugesAt in interface ISrvMonUserStatsindex - The index for which the element is to be returned.public final XIterator<SrvMonUserGaugeStat> getGaugesIterator()
ISrvMonUserStatsThis 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
getGaugesIterator in interface ISrvMonUserStatspublic final SrvMonUserGaugeStat[] takeGauges()
ISrvMonUserStats
NOTE:
A nested entity reference returned by ISrvMonUserStats.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.
takeGauges in interface ISrvMonUserStatsnull if the field is not set.public final void clearGauges()
ISrvMonUserStatsclearGauges in interface ISrvMonUserStatsISrvMonUserStats.setGauges(SrvMonUserGaugeStat[])public static final <T> IRogFieldReflector<SrvMonUserStats,T> getFieldReflector(String name)
name - The name of the field ('.' delimited for nested fields)public static final <T> IRogFieldReflector<SrvMonUserStats,T> getFieldReflector(String[] pathComponents)
pathComponents - The path to the field whose reflector is to be returnedpublic final Object getQueryFieldValue(String name)
com.neeve.query.impl.index.IdxMappableImplementation should ensure that the the type of the value returned is consistent across types.
getQueryFieldValue in interface com.neeve.query.impl.index.IdxMappablename - The name of the field whose value is to be accessed.public final SrvMonUserStats init()
UtlPool.ItemThis method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
init in interface UtlPool.Item<SrvMonUserStats>public final SrvMonUserStats setPool(UtlPool<SrvMonUserStats> pool)
UtlPool.ItemThis method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
setPool in interface UtlPool.Item<SrvMonUserStats>public final UtlPool<SrvMonUserStats> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool in interface UtlPool.Item<SrvMonUserStats>UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)public final SrvMonUserStats acquire()
public final int getOwnershipCount()
public final void dispose()
public final Object clone()
This method differs from the copy() method in that:
public final boolean isValid()
IRogValidatableisValid in interface IRogValidatablepublic final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatablegetValidationErrors in interface IRogValidatableresults - A results list into which validation errors will be collected.errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.Copyright © 2019 N5 Technologies, Inc. All Rights Reserved.