@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Thu May 07 15:37:32 EDT 2020") @AdmGenerated(encoding="Xbuf", 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)") @AdmFactoryInfo(factoryClass=SrvMonFactory.class, vfid=32, ofid=32, typeId=202) public final class SrvMonAppStats extends Object implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonAppStats>, ISrvMonAppStats
ADM Type | Embedded Entity |
Factory | SrvMonFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
appName | String | 16 | The application name. |
busBindingStats | SrvMonAppBusBindingStats[] | 20 | The applications messaging stats for each configured bus. |
engineStats | SrvMonAppEngineStats |
17 | The application's engine stats. |
eventMultiplexerStats | SrvMonAppEventMultiplexerStats |
18 | The application's input event multiplexer stats. |
storeBindingStats | SrvMonAppStoreBindingStats |
19 | The application's replication and persistent disk storage stats. |
userStats | SrvMonUserStats |
21 | The application's user defined stats. |
Modifier and Type | Class and Description |
---|---|
static class |
SrvMonAppStats.Field
The SrvMonAppStats xbuf field (used internally when this entity is used as a field of another entity).
|
static class |
SrvMonAppStats.ListField
The SrvMonAppStats list field (used internally when this entity is used as an array field of another entity).
|
Modifier and Type | Field and Description |
---|---|
static SrvMonAppStats[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
Constructor and Description |
---|
SrvMonAppStats() |
SrvMonAppStats(int initialBackingBufferSize) |
Modifier and Type | Method and Description |
---|---|
SrvMonAppStats |
acquire() |
void |
addBusBindingStats(SrvMonAppBusBindingStats val)
Adds the provided value to the list of 'busBindingStats' values.
|
void |
clearAppName()
Clears the value of 'appName'.
|
void |
clearBusBindingStats()
Clears the value of 'busBindingStats'.
|
void |
clearContent() |
void |
clearEngineStats()
Clears the value of 'engineStats'.
|
void |
clearEventMultiplexerStats()
Clears the value of 'eventMultiplexerStats'.
|
void |
clearStoreBindingStats()
Clears the value of 'storeBindingStats'.
|
void |
clearUserStats()
Clears the value of 'userStats'.
|
void |
clearXRogType() |
Object |
clone()
Creates a clone of this object.
|
SrvMonAppStats |
copy()
Creates a copy of this SrvMonAppStats.
|
void |
copyInto(SrvMonAppStats copy)
Copies the contents of this SrvMonAppStats into the target.
|
static SrvMonAppStats |
create() |
static SrvMonAppStats |
createFrom(byte[] serializedContainer) |
static SrvMonAppStats |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static SrvMonAppStats |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonAppStats |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonAppStats |
deserializeFromByteArray(byte[] array) |
SrvMonAppStats |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonAppStats |
deserializeFromByteBuffer(ByteBuffer buffer) |
SrvMonAppStats |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonAppStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length) |
SrvMonAppStats |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonAppStats |
deserializeFromNative(long address,
int offset,
int length) |
SrvMonAppStats |
deserializeFromNative(long address,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
Desync fields from a buffer
|
void |
desyncFieldBitmask() |
void |
dispose() |
String |
getAppName()
Gets the value of 'appName'.
|
com.neeve.xbuf.XbufStringField |
getAppNameField() |
static int |
getAppNameFieldId() |
<T extends XString> |
getAppNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getAppNameTo(XString val)
Copies the value of 'appName' into the provided XString.
|
XString |
getAppNameUnsafe()
Gets the raw value of 'appName'.
|
PktBuffer |
getBackingBuffer() |
SrvMonAppBusBindingStats[] |
getBusBindingStats()
Gets the value of 'busBindingStats'.
|
SrvMonAppBusBindingStats[] |
getBusBindingStatsEmptyIfNull()
Gets the value of 'busBindingStats' or an empty array if the value is
null or not set. |
static int |
getBusBindingStatsFieldId() |
XIterator<SrvMonAppBusBindingStats> |
getBusBindingStatsIterator()
Gets the value of 'busBindingStats' as iterator of values.
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
SrvMonAppEngineStats |
getEngineStats()
Gets the value of 'engineStats'.
|
static int |
getEngineStatsFieldId() |
void |
getEngineStatsTo(SrvMonAppEngineStats to)
Copies the value of SrvMonAppEngineStats into the provided value.
|
SrvMonAppEventMultiplexerStats |
getEventMultiplexerStats()
Gets the value of 'eventMultiplexerStats'.
|
static int |
getEventMultiplexerStatsFieldId() |
void |
getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats to)
Copies the value of SrvMonAppEventMultiplexerStats into the provided value.
|
boolean |
getIsReadOnly() |
int |
getOwnerCount() |
UtlPool<SrvMonAppStats> |
getPool()
Get a pool item's pool.
|
int |
getSerializeToNativeLength() |
SrvMonAppStoreBindingStats |
getStoreBindingStats()
Gets the value of 'storeBindingStats'.
|
static int |
getStoreBindingStatsFieldId() |
void |
getStoreBindingStatsTo(SrvMonAppStoreBindingStats to)
Copies the value of SrvMonAppStoreBindingStats into the provided value.
|
SrvMonUserStats |
getUserStats()
Gets the value of 'userStats'.
|
static int |
getUserStatsFieldId() |
void |
getUserStatsTo(SrvMonUserStats to)
Copies the value of SrvMonUserStats into the provided value.
|
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list.
|
short |
getXRogType() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
boolean |
hasAppName()
Checks for the presence of 'appName'.
|
boolean |
hasEngineStats()
Checks for the presence of 'engineStats'.
|
boolean |
hasEventMultiplexerStats()
Checks for the presence of 'eventMultiplexerStats'.
|
boolean |
hasStoreBindingStats()
Checks for the presence of 'storeBindingStats'.
|
boolean |
hasUserStats()
Checks for the presence of 'userStats'.
|
boolean |
hasXRogType() |
SrvMonAppStats |
init()
Initialize an item.
|
boolean |
isBufferBacked() |
boolean |
isDirty() |
boolean |
isReferenceCounted() |
boolean |
isValid()
Tests if this object has any validation errors.
|
void |
lendAppName(XString val)
Lends the value of 'appName' to this object.
|
void |
lendBusBindingStats(SrvMonAppBusBindingStats val)
Adds the provided value to the list of 'busBindingStats' values and acquires a reference to it.
|
void |
lendBusBindingStats(SrvMonAppBusBindingStats[] val)
Lends the value of 'busBindingStats'.
|
void |
lendBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)
Sets the value of 'busBindingStats' by lending the values from the provided iterator.
|
void |
lendEngineStats(SrvMonAppEngineStats val)
'Lends' a reference of the SrvMonAppEngineStats to the message for this field.
|
void |
lendEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
'Lends' a reference of the SrvMonAppEventMultiplexerStats to the message for this field.
|
void |
lendStoreBindingStats(SrvMonAppStoreBindingStats val)
'Lends' a reference of the SrvMonAppStoreBindingStats to the message for this field.
|
void |
lendUserStats(SrvMonUserStats val)
'Lends' a reference of the SrvMonUserStats to the message for this field.
|
static void |
optimizeFor(int val) |
byte[] |
serializeToByteArray() |
ByteBuffer |
serializeToByteBuffer() |
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative) |
int |
serializeToNative(long address,
int addressOffset) |
void |
setAppName(String val)
Sets the value of 'appName'.
|
void |
setAppNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setAppNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setAppNameFrom(XString val)
Copies the provided XString value into this object's 'appName'.
|
void |
setAsReadOnly() |
void |
setBusBindingStats(SrvMonAppBusBindingStats[] val)
Sets the value of 'busBindingStats'.
|
void |
setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)
Sets the value of 'busBindingStats' using the values from the provided iterator.
|
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
void |
setEngineStats(SrvMonAppEngineStats val)
Sets the value of 'engineStats'.
|
void |
setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
Sets the value of 'eventMultiplexerStats'.
|
static void |
setFieldInterest(List<Integer> fieldIds) |
SrvMonAppStats |
setPool(UtlPool<SrvMonAppStats> pool)
Set a pool item's pool.
|
void |
setPreserializedFields(PktBuffer buffer) |
void |
setStoreBindingStats(SrvMonAppStoreBindingStats val)
Sets the value of 'storeBindingStats'.
|
void |
setUserStats(SrvMonUserStats val)
Sets the value of 'userStats'.
|
void |
setXRogType(short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
sync() |
void |
syncFieldBitmask() |
SrvMonAppBusBindingStats[] |
takeBusBindingStats()
Takes the value of 'busBindingStats'.
|
SrvMonAppEngineStats |
takeEngineStats()
'Takes' a reference to the engineStats field from the message.
|
SrvMonAppEventMultiplexerStats |
takeEventMultiplexerStats()
'Takes' a reference to the eventMultiplexerStats field from the message.
|
SrvMonAppStoreBindingStats |
takeStoreBindingStats()
'Takes' a reference to the storeBindingStats field from the message.
|
SrvMonUserStats |
takeUserStats()
'Takes' a reference to the userStats field from the message.
|
String |
toString() |
public static final SrvMonAppStats[] EMPTY_ARRAY
public SrvMonAppStats()
public SrvMonAppStats(int initialBackingBufferSize)
public static SrvMonAppStats create()
public static SrvMonAppStats createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonAppStats createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonAppStats createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonAppStats createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getAppNameFieldId()
public final void setAppName(String val)
ISrvMonAppStats
setAppName
in interface ISrvMonAppStats
val
- The value to set.public final String getAppName()
ISrvMonAppStats
getAppName
in interface ISrvMonAppStats
public final void lendAppName(XString val)
ISrvMonAppStats
This method is equivalent to setAppName 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.
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.
lendAppName
in interface ISrvMonAppStats
val
- The value to set.public final void setAppNameFrom(long val)
ISrvMonAppStats
NOTE:
This is the same as calling ISrvMonAppStats.setAppName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAppNameFrom
in interface ISrvMonAppStats
public final <T extends XString> T getAppNameTo(XString.Factory<T> factory)
ISrvMonAppStats
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;
getAppNameTo
in interface ISrvMonAppStats
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setAppNameFrom(XString val)
ISrvMonAppStats
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonAppStats.setAppName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setAppNameFrom
in interface ISrvMonAppStats
public final void getAppNameTo(XString val)
ISrvMonAppStats
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonAppStats.getAppName()
bec
because it can avoid decoding the value into an String
.
getAppNameTo
in interface ISrvMonAppStats
ISrvMonAppStats.getAppName()
public final XString getAppNameUnsafe()
ISrvMonAppStats
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.
getAppNameUnsafe
in interface ISrvMonAppStats
ISrvMonAppStats.getAppName()
public final void setAppNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getAppNameField()
public final boolean hasAppName()
ISrvMonAppStats
hasAppName
in interface ISrvMonAppStats
ISrvMonAppStats.getAppName()
public final void clearAppName()
ISrvMonAppStats
clearAppName
in interface ISrvMonAppStats
ISrvMonAppStats.setAppName(String)
public static final int getEngineStatsFieldId()
public final void setEngineStats(SrvMonAppEngineStats val)
ISrvMonAppStats
setEngineStats
in interface ISrvMonAppStats
val
- The value to set.public final void lendEngineStats(SrvMonAppEngineStats val)
ISrvMonAppStats
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.
lendEngineStats
in interface ISrvMonAppStats
val
- the value to 'lend' to lend.public final SrvMonAppEngineStats getEngineStats()
ISrvMonAppStats
getEngineStats
in interface ISrvMonAppStats
public final void getEngineStatsTo(SrvMonAppEngineStats to)
ISrvMonAppStats
IF the value is not set, then the contents of the provided SrvMonAppEngineStats are cleared.
getEngineStatsTo
in interface ISrvMonAppStats
to
- the value to copy intoSrvMonAppEngineStats.copyInto(SrvMonAppEngineStats)
public final SrvMonAppEngineStats takeEngineStats()
ISrvMonAppStats
NOTE:
A nested entity reference returned by getXXX() 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.
takeEngineStats
in interface ISrvMonAppStats
null
if the field is not set.public final boolean hasEngineStats()
ISrvMonAppStats
hasEngineStats
in interface ISrvMonAppStats
ISrvMonAppStats.getEngineStats()
public final void clearEngineStats()
ISrvMonAppStats
clearEngineStats
in interface ISrvMonAppStats
ISrvMonAppStats.setEngineStats(SrvMonAppEngineStats)
public static final int getEventMultiplexerStatsFieldId()
public final void setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
ISrvMonAppStats
setEventMultiplexerStats
in interface ISrvMonAppStats
val
- The value to set.public final void lendEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
ISrvMonAppStats
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.
lendEventMultiplexerStats
in interface ISrvMonAppStats
val
- the value to 'lend' to lend.public final SrvMonAppEventMultiplexerStats getEventMultiplexerStats()
ISrvMonAppStats
getEventMultiplexerStats
in interface ISrvMonAppStats
public final void getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats to)
ISrvMonAppStats
IF the value is not set, then the contents of the provided SrvMonAppEventMultiplexerStats are cleared.
getEventMultiplexerStatsTo
in interface ISrvMonAppStats
to
- the value to copy intoSrvMonAppEventMultiplexerStats.copyInto(SrvMonAppEventMultiplexerStats)
public final SrvMonAppEventMultiplexerStats takeEventMultiplexerStats()
ISrvMonAppStats
NOTE:
A nested entity reference returned by getXXX() 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.
takeEventMultiplexerStats
in interface ISrvMonAppStats
null
if the field is not set.public final boolean hasEventMultiplexerStats()
ISrvMonAppStats
hasEventMultiplexerStats
in interface ISrvMonAppStats
ISrvMonAppStats.getEventMultiplexerStats()
public final void clearEventMultiplexerStats()
ISrvMonAppStats
clearEventMultiplexerStats
in interface ISrvMonAppStats
ISrvMonAppStats.setEventMultiplexerStats(SrvMonAppEventMultiplexerStats)
public static final int getStoreBindingStatsFieldId()
public final void setStoreBindingStats(SrvMonAppStoreBindingStats val)
ISrvMonAppStats
setStoreBindingStats
in interface ISrvMonAppStats
val
- The value to set.public final void lendStoreBindingStats(SrvMonAppStoreBindingStats val)
ISrvMonAppStats
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.
lendStoreBindingStats
in interface ISrvMonAppStats
val
- the value to 'lend' to lend.public final SrvMonAppStoreBindingStats getStoreBindingStats()
ISrvMonAppStats
getStoreBindingStats
in interface ISrvMonAppStats
public final void getStoreBindingStatsTo(SrvMonAppStoreBindingStats to)
ISrvMonAppStats
IF the value is not set, then the contents of the provided SrvMonAppStoreBindingStats are cleared.
getStoreBindingStatsTo
in interface ISrvMonAppStats
to
- the value to copy intoSrvMonAppStoreBindingStats.copyInto(SrvMonAppStoreBindingStats)
public final SrvMonAppStoreBindingStats takeStoreBindingStats()
ISrvMonAppStats
NOTE:
A nested entity reference returned by getXXX() 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.
takeStoreBindingStats
in interface ISrvMonAppStats
null
if the field is not set.public final boolean hasStoreBindingStats()
ISrvMonAppStats
hasStoreBindingStats
in interface ISrvMonAppStats
ISrvMonAppStats.getStoreBindingStats()
public final void clearStoreBindingStats()
ISrvMonAppStats
clearStoreBindingStats
in interface ISrvMonAppStats
ISrvMonAppStats.setStoreBindingStats(SrvMonAppStoreBindingStats)
public static final int getBusBindingStatsFieldId()
public final void setBusBindingStats(SrvMonAppBusBindingStats[] val)
ISrvMonAppStats
setBusBindingStats
in interface ISrvMonAppStats
val
- The value to set.public final void setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)
ISrvMonAppStats
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 'busBindingStats' accessor can copy the values without iteration.
NOTE:
Passing a null
or empty list has the same affect as calling ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[])
with
a value of null
.
setBusBindingStatsFrom
in interface ISrvMonAppStats
val
- the values to set.public final void lendBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)
ISrvMonAppStats
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 'busBindingStats' accessor can copy the values without iteration.
NOTE:
Passing a null
or empty list has the same affect as calling ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[])
with
a value of null
.
lendBusBindingStatsFrom
in interface ISrvMonAppStats
val
- the values to set.public final void lendBusBindingStats(SrvMonAppBusBindingStats[] val)
ISrvMonAppStats
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.
lendBusBindingStats
in interface ISrvMonAppStats
val
- the value to 'lend' to lend.public final void addBusBindingStats(SrvMonAppBusBindingStats val)
ISrvMonAppStats
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'busBindingStats' 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.
addBusBindingStats
in interface ISrvMonAppStats
val
- the value to add.public final void lendBusBindingStats(SrvMonAppBusBindingStats val)
ISrvMonAppStats
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 'busBindingStats' 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.
lendBusBindingStats
in interface ISrvMonAppStats
val
- the value to add.public final SrvMonAppBusBindingStats[] getBusBindingStats()
ISrvMonAppStats
If the field is not set this method will return null
.
getBusBindingStats
in interface ISrvMonAppStats
null
.public final SrvMonAppBusBindingStats[] getBusBindingStatsEmptyIfNull()
ISrvMonAppStats
null
or not set.
getBusBindingStatsEmptyIfNull
in interface ISrvMonAppStats
null
if not set.ISrvMonAppStats.getBusBindingStats()
public final XIterator<SrvMonAppBusBindingStats> getBusBindingStatsIterator()
ISrvMonAppStats
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
getBusBindingStatsIterator
in interface ISrvMonAppStats
public final SrvMonAppBusBindingStats[] takeBusBindingStats()
ISrvMonAppStats
NOTE:
A nested entity reference returned by ISrvMonAppStats.getBusBindingStats()
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.
takeBusBindingStats
in interface ISrvMonAppStats
null
if the field is not set.public final void clearBusBindingStats()
ISrvMonAppStats
clearBusBindingStats
in interface ISrvMonAppStats
ISrvMonAppStats.setBusBindingStats(SrvMonAppBusBindingStats[])
public static final int getUserStatsFieldId()
public final void setUserStats(SrvMonUserStats val)
ISrvMonAppStats
setUserStats
in interface ISrvMonAppStats
val
- The value to set.public final void lendUserStats(SrvMonUserStats val)
ISrvMonAppStats
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.
lendUserStats
in interface ISrvMonAppStats
val
- the value to 'lend' to lend.public final SrvMonUserStats getUserStats()
ISrvMonAppStats
getUserStats
in interface ISrvMonAppStats
public final void getUserStatsTo(SrvMonUserStats to)
ISrvMonAppStats
IF the value is not set, then the contents of the provided SrvMonUserStats are cleared.
getUserStatsTo
in interface ISrvMonAppStats
to
- the value to copy intoSrvMonUserStats.copyInto(SrvMonUserStats)
public final SrvMonUserStats takeUserStats()
ISrvMonAppStats
NOTE:
A nested entity reference returned by getXXX() 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.
takeUserStats
in interface ISrvMonAppStats
null
if the field is not set.public final boolean hasUserStats()
ISrvMonAppStats
hasUserStats
in interface ISrvMonAppStats
ISrvMonAppStats.getUserStats()
public final void clearUserStats()
ISrvMonAppStats
clearUserStats
in interface ISrvMonAppStats
ISrvMonAppStats.setUserStats(SrvMonUserStats)
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address, int addressOffset)
public final SrvMonAppStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonAppStats deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonAppStats deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonAppStats deserializeFromByteArray(byte[] array)
public final SrvMonAppStats deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonAppStats deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonAppStats deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonAppStats deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncer
desync
in interface com.neeve.xbuf.IXbufDesyncer
buffer
- The buffer to desync frompos
- The position in the container's backing buffer to desync
fromframeOnly
- Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean)
for more
informationpublic final SrvMonAppStats init()
UtlPool.Item
This 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<SrvMonAppStats>
public final SrvMonAppStats setPool(UtlPool<SrvMonAppStats> pool)
UtlPool.Item
This 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<SrvMonAppStats>
public final UtlPool<SrvMonAppStats> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool
in interface UtlPool.Item<SrvMonAppStats>
UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
public final boolean isReferenceCounted()
public final SrvMonAppStats acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy()
method in that:
public final SrvMonAppStats copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppStats is read only.
public final void copyInto(SrvMonAppStats copy)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonAppStats's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppStats is read only.
copy
- The target into which to copy.public final boolean isValid()
IRogValidatable
isValid
in interface IRogValidatable
public final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatable
getValidationErrors
in interface IRogValidatable
results
- 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 Neeve Research, LLC. All Rights Reserved.