@Generated(value="com.neeve.adm.AdmGenerator", date="Tue Sep 16 04:36:05 UTC 2025") @AdmGenerated(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)") public interface ISrvMonSysMemoryStats extends IRogValidatable
| ADM Type | Embedded Entity |
| Factory | SrvMonHeartbeatFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| collectionCounters | SrvMonSysMemoryEntityTypeCounters |
13 | Holds counters related to collection management by the applications in the JVM. |
| collectionCountersByType | SrvMonSysMemoryEntityTypeCounters[] | 18 | Holds counters related to collection management by type by the applications in the JVM. |
| committedVirtualMemorySize | Long | 3 | The amount of virtual memory that is guaranteed to be available to the running process in bytes. |
| embeddedEntityCounters | SrvMonSysMemoryEntityTypeCounters |
14 | Holds counters related to embedded entity management by the applications in the JVM. |
| embeddedEntityCountersByType | SrvMonSysMemoryEntityTypeCounters[] | 15 | Holds counters related to embedded entity management by type by the applications in the JVM. |
| entityCounters | SrvMonSysMemoryEntityTypeCounters |
11 | Holds counters related to state entity management by the applications in the JVM. |
| entityCountersByType | SrvMonSysMemoryEntityTypeCounters[] | 16 | Holds counters related to state entity management by type by the applications in the JVM. |
| freePhysicalMemorySize | Long | 4 | The amount of free physical memory in bytes. |
| freeSwapSpaceSize | Long | 5 | The amount of free swap space in bytes. |
| heapUsage | SrvMonSysMemoryUsage |
1 | Holds stats about heap memory usage. |
| iobufCounters | SrvMonSysMemoryIOBufCounters |
10 | Holds counters related to IOBuffer management by the applications in the JVM. |
| messageCounters | SrvMonSysMemoryEntityTypeCounters |
12 | Holds counters related to message management by the applications in the JVM. |
| messageCountersByType | SrvMonSysMemoryEntityTypeCounters[] | 17 | Holds counters related to message management by type by the applications in the JVM. |
| nativeCounters | SrvMonSysMemoryNativeCounters |
9 | Holds counters related to native memory management by the applications in the JVM. |
| nonHeapUsage | SrvMonSysMemoryUsage |
2 | Holds stats about non heap memory usage by the JVM. |
| offHeapUsage | SrvMonSysMemoryOffHeapUsage |
8 | Holds stats about off heap memory usage by the applications in the JVM. |
| totalPhysicalMemorySize | Long | 6 | The total amount of physical memory in bytes. |
| totalSwapSpaceSize | Long | 7 | The total amount of swap space in bytes. |
| Modifier and Type | Method and Description |
|---|---|
void |
addCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'collectionCountersByType' values.
|
void |
addEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'embeddedEntityCountersByType' values.
|
void |
addEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'entityCountersByType' values.
|
void |
addMessageCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'messageCountersByType' values.
|
void |
clearCollectionCounters()
Clears the value of 'collectionCounters'.
|
void |
clearCollectionCountersByType()
Clears the value of 'collectionCountersByType'.
|
void |
clearCommittedVirtualMemorySize()
Clears the value of 'committedVirtualMemorySize'.
|
void |
clearEmbeddedEntityCounters()
Clears the value of 'embeddedEntityCounters'.
|
void |
clearEmbeddedEntityCountersByType()
Clears the value of 'embeddedEntityCountersByType'.
|
void |
clearEntityCounters()
Clears the value of 'entityCounters'.
|
void |
clearEntityCountersByType()
Clears the value of 'entityCountersByType'.
|
void |
clearFreePhysicalMemorySize()
Clears the value of 'freePhysicalMemorySize'.
|
void |
clearFreeSwapSpaceSize()
Clears the value of 'freeSwapSpaceSize'.
|
void |
clearHeapUsage()
Clears the value of 'heapUsage'.
|
void |
clearIobufCounters()
Clears the value of 'iobufCounters'.
|
void |
clearMessageCounters()
Clears the value of 'messageCounters'.
|
void |
clearMessageCountersByType()
Clears the value of 'messageCountersByType'.
|
void |
clearNativeCounters()
Clears the value of 'nativeCounters'.
|
void |
clearNonHeapUsage()
Clears the value of 'nonHeapUsage'.
|
void |
clearOffHeapUsage()
Clears the value of 'offHeapUsage'.
|
void |
clearTotalPhysicalMemorySize()
Clears the value of 'totalPhysicalMemorySize'.
|
void |
clearTotalSwapSpaceSize()
Clears the value of 'totalSwapSpaceSize'.
|
SrvMonSysMemoryEntityTypeCounters |
getCollectionCounters()
Gets the value of 'collectionCounters'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getCollectionCountersByType()
Gets the value of 'collectionCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
getCollectionCountersByTypeAt(int index)
Gets the element of 'collectionCountersByType' at a specified index.
|
int |
getCollectionCountersByTypeCount()
Gets number of elements in 'collectionCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getCollectionCountersByTypeEmptyIfNull()
Gets the value of 'collectionCountersByType' or an empty array if the value is
null or not set. |
XIterator<SrvMonSysMemoryEntityTypeCounters> |
getCollectionCountersByTypeIterator()
Gets the value of 'collectionCountersByType' as iterator of values.
|
void |
getCollectionCountersTo(SrvMonSysMemoryEntityTypeCounters val)
Copies the value of SrvMonSysMemoryEntityTypeCounters into the provided value.
|
long |
getCommittedVirtualMemorySize()
Gets the value of 'committedVirtualMemorySize'.
|
Long |
getCommittedVirtualMemorySizeAsObject()
Gets the value of 'committedVirtualMemorySize'.
|
SrvMonSysMemoryEntityTypeCounters |
getEmbeddedEntityCounters()
Gets the value of 'embeddedEntityCounters'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getEmbeddedEntityCountersByType()
Gets the value of 'embeddedEntityCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
getEmbeddedEntityCountersByTypeAt(int index)
Gets the element of 'embeddedEntityCountersByType' at a specified index.
|
int |
getEmbeddedEntityCountersByTypeCount()
Gets number of elements in 'embeddedEntityCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getEmbeddedEntityCountersByTypeEmptyIfNull()
Gets the value of 'embeddedEntityCountersByType' or an empty array if the value is
null or not set. |
XIterator<SrvMonSysMemoryEntityTypeCounters> |
getEmbeddedEntityCountersByTypeIterator()
Gets the value of 'embeddedEntityCountersByType' as iterator of values.
|
void |
getEmbeddedEntityCountersTo(SrvMonSysMemoryEntityTypeCounters val)
Copies the value of SrvMonSysMemoryEntityTypeCounters into the provided value.
|
SrvMonSysMemoryEntityTypeCounters |
getEntityCounters()
Gets the value of 'entityCounters'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getEntityCountersByType()
Gets the value of 'entityCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
getEntityCountersByTypeAt(int index)
Gets the element of 'entityCountersByType' at a specified index.
|
int |
getEntityCountersByTypeCount()
Gets number of elements in 'entityCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getEntityCountersByTypeEmptyIfNull()
Gets the value of 'entityCountersByType' or an empty array if the value is
null or not set. |
XIterator<SrvMonSysMemoryEntityTypeCounters> |
getEntityCountersByTypeIterator()
Gets the value of 'entityCountersByType' as iterator of values.
|
void |
getEntityCountersTo(SrvMonSysMemoryEntityTypeCounters val)
Copies the value of SrvMonSysMemoryEntityTypeCounters into the provided value.
|
long |
getFreePhysicalMemorySize()
Gets the value of 'freePhysicalMemorySize'.
|
Long |
getFreePhysicalMemorySizeAsObject()
Gets the value of 'freePhysicalMemorySize'.
|
long |
getFreeSwapSpaceSize()
Gets the value of 'freeSwapSpaceSize'.
|
Long |
getFreeSwapSpaceSizeAsObject()
Gets the value of 'freeSwapSpaceSize'.
|
SrvMonSysMemoryUsage |
getHeapUsage()
Gets the value of 'heapUsage'.
|
void |
getHeapUsageTo(SrvMonSysMemoryUsage val)
Copies the value of SrvMonSysMemoryUsage into the provided value.
|
SrvMonSysMemoryIOBufCounters |
getIobufCounters()
Gets the value of 'iobufCounters'.
|
void |
getIobufCountersTo(SrvMonSysMemoryIOBufCounters val)
Copies the value of SrvMonSysMemoryIOBufCounters into the provided value.
|
SrvMonSysMemoryEntityTypeCounters |
getMessageCounters()
Gets the value of 'messageCounters'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getMessageCountersByType()
Gets the value of 'messageCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
getMessageCountersByTypeAt(int index)
Gets the element of 'messageCountersByType' at a specified index.
|
int |
getMessageCountersByTypeCount()
Gets number of elements in 'messageCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters[] |
getMessageCountersByTypeEmptyIfNull()
Gets the value of 'messageCountersByType' or an empty array if the value is
null or not set. |
XIterator<SrvMonSysMemoryEntityTypeCounters> |
getMessageCountersByTypeIterator()
Gets the value of 'messageCountersByType' as iterator of values.
|
void |
getMessageCountersTo(SrvMonSysMemoryEntityTypeCounters val)
Copies the value of SrvMonSysMemoryEntityTypeCounters into the provided value.
|
SrvMonSysMemoryNativeCounters |
getNativeCounters()
Gets the value of 'nativeCounters'.
|
void |
getNativeCountersTo(SrvMonSysMemoryNativeCounters val)
Copies the value of SrvMonSysMemoryNativeCounters into the provided value.
|
SrvMonSysMemoryUsage |
getNonHeapUsage()
Gets the value of 'nonHeapUsage'.
|
void |
getNonHeapUsageTo(SrvMonSysMemoryUsage val)
Copies the value of SrvMonSysMemoryUsage into the provided value.
|
SrvMonSysMemoryOffHeapUsage |
getOffHeapUsage()
Gets the value of 'offHeapUsage'.
|
void |
getOffHeapUsageTo(SrvMonSysMemoryOffHeapUsage val)
Copies the value of SrvMonSysMemoryOffHeapUsage into the provided value.
|
long |
getTotalPhysicalMemorySize()
Gets the value of 'totalPhysicalMemorySize'.
|
Long |
getTotalPhysicalMemorySizeAsObject()
Gets the value of 'totalPhysicalMemorySize'.
|
long |
getTotalSwapSpaceSize()
Gets the value of 'totalSwapSpaceSize'.
|
Long |
getTotalSwapSpaceSizeAsObject()
Gets the value of 'totalSwapSpaceSize'.
|
boolean |
hasCollectionCounters()
Checks for the presence of 'collectionCounters'.
|
boolean |
hasCommittedVirtualMemorySize()
Checks for the presence of 'committedVirtualMemorySize'.
|
boolean |
hasEmbeddedEntityCounters()
Checks for the presence of 'embeddedEntityCounters'.
|
boolean |
hasEntityCounters()
Checks for the presence of 'entityCounters'.
|
boolean |
hasFreePhysicalMemorySize()
Checks for the presence of 'freePhysicalMemorySize'.
|
boolean |
hasFreeSwapSpaceSize()
Checks for the presence of 'freeSwapSpaceSize'.
|
boolean |
hasHeapUsage()
Checks for the presence of 'heapUsage'.
|
boolean |
hasIobufCounters()
Checks for the presence of 'iobufCounters'.
|
boolean |
hasMessageCounters()
Checks for the presence of 'messageCounters'.
|
boolean |
hasNativeCounters()
Checks for the presence of 'nativeCounters'.
|
boolean |
hasNonHeapUsage()
Checks for the presence of 'nonHeapUsage'.
|
boolean |
hasOffHeapUsage()
Checks for the presence of 'offHeapUsage'.
|
boolean |
hasTotalPhysicalMemorySize()
Checks for the presence of 'totalPhysicalMemorySize'.
|
boolean |
hasTotalSwapSpaceSize()
Checks for the presence of 'totalSwapSpaceSize'.
|
void |
lendCollectionCounters(SrvMonSysMemoryEntityTypeCounters val)
'Lends' a reference of the SrvMonSysMemoryEntityTypeCounters to the message for this field.
|
void |
lendCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'collectionCountersByType' values and acquires a reference to it.
|
void |
lendCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Lends the value of 'collectionCountersByType'.
|
void |
lendCollectionCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'collectionCountersByType' by lending the values from the provided iterator.
|
void |
lendEmbeddedEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
'Lends' a reference of the SrvMonSysMemoryEntityTypeCounters to the message for this field.
|
void |
lendEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'embeddedEntityCountersByType' values and acquires a reference to it.
|
void |
lendEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Lends the value of 'embeddedEntityCountersByType'.
|
void |
lendEmbeddedEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'embeddedEntityCountersByType' by lending the values from the provided iterator.
|
void |
lendEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
'Lends' a reference of the SrvMonSysMemoryEntityTypeCounters to the message for this field.
|
void |
lendEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'entityCountersByType' values and acquires a reference to it.
|
void |
lendEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Lends the value of 'entityCountersByType'.
|
void |
lendEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'entityCountersByType' by lending the values from the provided iterator.
|
void |
lendHeapUsage(SrvMonSysMemoryUsage val)
'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.
|
void |
lendIobufCounters(SrvMonSysMemoryIOBufCounters val)
'Lends' a reference of the SrvMonSysMemoryIOBufCounters to the message for this field.
|
void |
lendMessageCounters(SrvMonSysMemoryEntityTypeCounters val)
'Lends' a reference of the SrvMonSysMemoryEntityTypeCounters to the message for this field.
|
void |
lendMessageCountersByType(SrvMonSysMemoryEntityTypeCounters val)
Adds the provided value to the list of 'messageCountersByType' values and acquires a reference to it.
|
void |
lendMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Lends the value of 'messageCountersByType'.
|
void |
lendMessageCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'messageCountersByType' by lending the values from the provided iterator.
|
void |
lendNativeCounters(SrvMonSysMemoryNativeCounters val)
'Lends' a reference of the SrvMonSysMemoryNativeCounters to the message for this field.
|
void |
lendNonHeapUsage(SrvMonSysMemoryUsage val)
'Lends' a reference of the SrvMonSysMemoryUsage to the message for this field.
|
void |
lendOffHeapUsage(SrvMonSysMemoryOffHeapUsage val)
'Lends' a reference of the SrvMonSysMemoryOffHeapUsage to the message for this field.
|
void |
setCollectionCounters(SrvMonSysMemoryEntityTypeCounters val)
Sets the value of 'collectionCounters'.
|
void |
setCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Sets the value of 'collectionCountersByType'.
|
void |
setCollectionCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'collectionCountersByType' using the values from the provided iterator.
|
void |
setCommittedVirtualMemorySize(long val)
Sets the value of 'committedVirtualMemorySize'.
|
void |
setEmbeddedEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
Sets the value of 'embeddedEntityCounters'.
|
void |
setEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Sets the value of 'embeddedEntityCountersByType'.
|
void |
setEmbeddedEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'embeddedEntityCountersByType' using the values from the provided iterator.
|
void |
setEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
Sets the value of 'entityCounters'.
|
void |
setEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Sets the value of 'entityCountersByType'.
|
void |
setEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'entityCountersByType' using the values from the provided iterator.
|
void |
setFreePhysicalMemorySize(long val)
Sets the value of 'freePhysicalMemorySize'.
|
void |
setFreeSwapSpaceSize(long val)
Sets the value of 'freeSwapSpaceSize'.
|
void |
setHeapUsage(SrvMonSysMemoryUsage val)
Sets the value of 'heapUsage'.
|
void |
setIobufCounters(SrvMonSysMemoryIOBufCounters val)
Sets the value of 'iobufCounters'.
|
void |
setMessageCounters(SrvMonSysMemoryEntityTypeCounters val)
Sets the value of 'messageCounters'.
|
void |
setMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
Sets the value of 'messageCountersByType'.
|
void |
setMessageCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
Sets the value of 'messageCountersByType' using the values from the provided iterator.
|
void |
setNativeCounters(SrvMonSysMemoryNativeCounters val)
Sets the value of 'nativeCounters'.
|
void |
setNonHeapUsage(SrvMonSysMemoryUsage val)
Sets the value of 'nonHeapUsage'.
|
void |
setOffHeapUsage(SrvMonSysMemoryOffHeapUsage val)
Sets the value of 'offHeapUsage'.
|
void |
setTotalPhysicalMemorySize(long val)
Sets the value of 'totalPhysicalMemorySize'.
|
void |
setTotalSwapSpaceSize(long val)
Sets the value of 'totalSwapSpaceSize'.
|
SrvMonSysMemoryEntityTypeCounters |
takeCollectionCounters()
'Takes' a reference to the collectionCounters field from the message.
|
SrvMonSysMemoryEntityTypeCounters[] |
takeCollectionCountersByType()
Takes the value of 'collectionCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
takeEmbeddedEntityCounters()
'Takes' a reference to the embeddedEntityCounters field from the message.
|
SrvMonSysMemoryEntityTypeCounters[] |
takeEmbeddedEntityCountersByType()
Takes the value of 'embeddedEntityCountersByType'.
|
SrvMonSysMemoryEntityTypeCounters |
takeEntityCounters()
'Takes' a reference to the entityCounters field from the message.
|
SrvMonSysMemoryEntityTypeCounters[] |
takeEntityCountersByType()
Takes the value of 'entityCountersByType'.
|
SrvMonSysMemoryUsage |
takeHeapUsage()
'Takes' a reference to the heapUsage field from the message.
|
SrvMonSysMemoryIOBufCounters |
takeIobufCounters()
'Takes' a reference to the iobufCounters field from the message.
|
SrvMonSysMemoryEntityTypeCounters |
takeMessageCounters()
'Takes' a reference to the messageCounters field from the message.
|
SrvMonSysMemoryEntityTypeCounters[] |
takeMessageCountersByType()
Takes the value of 'messageCountersByType'.
|
SrvMonSysMemoryNativeCounters |
takeNativeCounters()
'Takes' a reference to the nativeCounters field from the message.
|
SrvMonSysMemoryUsage |
takeNonHeapUsage()
'Takes' a reference to the nonHeapUsage field from the message.
|
SrvMonSysMemoryOffHeapUsage |
takeOffHeapUsage()
'Takes' a reference to the offHeapUsage field from the message.
|
getValidationErrors, isValidvoid setCommittedVirtualMemorySize(long val)
val - The value to set.long getCommittedVirtualMemorySize()
Long getCommittedVirtualMemorySizeAsObject()
void clearCommittedVirtualMemorySize()
setCommittedVirtualMemorySize(long)boolean hasCommittedVirtualMemorySize()
getCommittedVirtualMemorySize()void setFreePhysicalMemorySize(long val)
val - The value to set.long getFreePhysicalMemorySize()
Long getFreePhysicalMemorySizeAsObject()
void clearFreePhysicalMemorySize()
setFreePhysicalMemorySize(long)boolean hasFreePhysicalMemorySize()
getFreePhysicalMemorySize()void setFreeSwapSpaceSize(long val)
val - The value to set.long getFreeSwapSpaceSize()
Long getFreeSwapSpaceSizeAsObject()
void clearFreeSwapSpaceSize()
setFreeSwapSpaceSize(long)boolean hasFreeSwapSpaceSize()
getFreeSwapSpaceSize()void setTotalPhysicalMemorySize(long val)
val - The value to set.long getTotalPhysicalMemorySize()
Long getTotalPhysicalMemorySizeAsObject()
void clearTotalPhysicalMemorySize()
setTotalPhysicalMemorySize(long)boolean hasTotalPhysicalMemorySize()
getTotalPhysicalMemorySize()void setTotalSwapSpaceSize(long val)
val - The value to set.long getTotalSwapSpaceSize()
Long getTotalSwapSpaceSizeAsObject()
void clearTotalSwapSpaceSize()
setTotalSwapSpaceSize(long)boolean hasTotalSwapSpaceSize()
getTotalSwapSpaceSize()void setHeapUsage(SrvMonSysMemoryUsage val)
val - The value to set.void lendHeapUsage(SrvMonSysMemoryUsage val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryUsage getHeapUsage()
void getHeapUsageTo(SrvMonSysMemoryUsage val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryUsage are cleared.
val - the value to copy intoSrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)SrvMonSysMemoryUsage takeHeapUsage()
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.
null if the field is not set.boolean hasHeapUsage()
getHeapUsage()void clearHeapUsage()
setHeapUsage(SrvMonSysMemoryUsage)void setNonHeapUsage(SrvMonSysMemoryUsage val)
val - The value to set.void lendNonHeapUsage(SrvMonSysMemoryUsage val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryUsage getNonHeapUsage()
void getNonHeapUsageTo(SrvMonSysMemoryUsage val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryUsage are cleared.
val - the value to copy intoSrvMonSysMemoryUsage.copyInto(SrvMonSysMemoryUsage)SrvMonSysMemoryUsage takeNonHeapUsage()
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.
null if the field is not set.boolean hasNonHeapUsage()
getNonHeapUsage()void clearNonHeapUsage()
setNonHeapUsage(SrvMonSysMemoryUsage)void setOffHeapUsage(SrvMonSysMemoryOffHeapUsage val)
val - The value to set.void lendOffHeapUsage(SrvMonSysMemoryOffHeapUsage val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryOffHeapUsage getOffHeapUsage()
void getOffHeapUsageTo(SrvMonSysMemoryOffHeapUsage val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryOffHeapUsage are cleared.
val - the value to copy intoSrvMonSysMemoryOffHeapUsage.copyInto(SrvMonSysMemoryOffHeapUsage)SrvMonSysMemoryOffHeapUsage takeOffHeapUsage()
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.
null if the field is not set.boolean hasOffHeapUsage()
getOffHeapUsage()void clearOffHeapUsage()
void setNativeCounters(SrvMonSysMemoryNativeCounters val)
val - The value to set.void lendNativeCounters(SrvMonSysMemoryNativeCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryNativeCounters getNativeCounters()
void getNativeCountersTo(SrvMonSysMemoryNativeCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryNativeCounters are cleared.
val - the value to copy intoSrvMonSysMemoryNativeCounters.copyInto(SrvMonSysMemoryNativeCounters)SrvMonSysMemoryNativeCounters takeNativeCounters()
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.
null if the field is not set.boolean hasNativeCounters()
getNativeCounters()void clearNativeCounters()
void setIobufCounters(SrvMonSysMemoryIOBufCounters val)
val - The value to set.void lendIobufCounters(SrvMonSysMemoryIOBufCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryIOBufCounters getIobufCounters()
void getIobufCountersTo(SrvMonSysMemoryIOBufCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryIOBufCounters are cleared.
val - the value to copy intoSrvMonSysMemoryIOBufCounters.copyInto(SrvMonSysMemoryIOBufCounters)SrvMonSysMemoryIOBufCounters takeIobufCounters()
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.
null if the field is not set.boolean hasIobufCounters()
getIobufCounters()void clearIobufCounters()
void setEmbeddedEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
val - The value to set.void lendEmbeddedEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryEntityTypeCounters getEmbeddedEntityCounters()
void getEmbeddedEntityCountersTo(SrvMonSysMemoryEntityTypeCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryEntityTypeCounters are cleared.
val - the value to copy intoSrvMonSysMemoryEntityTypeCounters.copyInto(SrvMonSysMemoryEntityTypeCounters)SrvMonSysMemoryEntityTypeCounters takeEmbeddedEntityCounters()
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.
null if the field is not set.boolean hasEmbeddedEntityCounters()
getEmbeddedEntityCounters()void clearEmbeddedEntityCounters()
void setEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
val - The value to set.void setEmbeddedEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'embeddedEntityCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void lendEmbeddedEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'embeddedEntityCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void addEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'embeddedEntityCountersByType' 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.
val - the value to add.void lendEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
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 'embeddedEntityCountersByType' 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.
val - the value to add.void lendEmbeddedEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
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.
val - the value to 'lend' to lend.int getEmbeddedEntityCountersByTypeCount()
SrvMonSysMemoryEntityTypeCounters getEmbeddedEntityCountersByTypeAt(int index)
index - The index for which the element is to be returned.XIterator<SrvMonSysMemoryEntityTypeCounters> getEmbeddedEntityCountersByTypeIterator()
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
SrvMonSysMemoryEntityTypeCounters[] getEmbeddedEntityCountersByType()
If the field is not set this method will return null.
null.SrvMonSysMemoryEntityTypeCounters[] getEmbeddedEntityCountersByTypeEmptyIfNull()
null or not set.
null if not set.getEmbeddedEntityCountersByType()SrvMonSysMemoryEntityTypeCounters[] takeEmbeddedEntityCountersByType()
NOTE:
A nested entity reference returned by getEmbeddedEntityCountersByType() 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.
null if the field is not set.void clearEmbeddedEntityCountersByType()
void setEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
val - The value to set.void lendEntityCounters(SrvMonSysMemoryEntityTypeCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryEntityTypeCounters getEntityCounters()
void getEntityCountersTo(SrvMonSysMemoryEntityTypeCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryEntityTypeCounters are cleared.
val - the value to copy intoSrvMonSysMemoryEntityTypeCounters.copyInto(SrvMonSysMemoryEntityTypeCounters)SrvMonSysMemoryEntityTypeCounters takeEntityCounters()
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.
null if the field is not set.boolean hasEntityCounters()
getEntityCounters()void clearEntityCounters()
void setEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
val - The value to set.void setEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'entityCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void lendEntityCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'entityCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void addEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'entityCountersByType' 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.
val - the value to add.void lendEntityCountersByType(SrvMonSysMemoryEntityTypeCounters val)
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 'entityCountersByType' 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.
val - the value to add.void lendEntityCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
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.
val - the value to 'lend' to lend.int getEntityCountersByTypeCount()
SrvMonSysMemoryEntityTypeCounters getEntityCountersByTypeAt(int index)
index - The index for which the element is to be returned.XIterator<SrvMonSysMemoryEntityTypeCounters> getEntityCountersByTypeIterator()
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
SrvMonSysMemoryEntityTypeCounters[] getEntityCountersByType()
If the field is not set this method will return null.
null.SrvMonSysMemoryEntityTypeCounters[] getEntityCountersByTypeEmptyIfNull()
null or not set.
null if not set.getEntityCountersByType()SrvMonSysMemoryEntityTypeCounters[] takeEntityCountersByType()
NOTE:
A nested entity reference returned by getEntityCountersByType() 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.
null if the field is not set.void clearEntityCountersByType()
void setMessageCounters(SrvMonSysMemoryEntityTypeCounters val)
val - The value to set.void lendMessageCounters(SrvMonSysMemoryEntityTypeCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryEntityTypeCounters getMessageCounters()
void getMessageCountersTo(SrvMonSysMemoryEntityTypeCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryEntityTypeCounters are cleared.
val - the value to copy intoSrvMonSysMemoryEntityTypeCounters.copyInto(SrvMonSysMemoryEntityTypeCounters)SrvMonSysMemoryEntityTypeCounters takeMessageCounters()
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.
null if the field is not set.boolean hasMessageCounters()
getMessageCounters()void clearMessageCounters()
void setMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
val - The value to set.void setMessageCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'messageCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void lendMessageCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'messageCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void addMessageCountersByType(SrvMonSysMemoryEntityTypeCounters val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'messageCountersByType' 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.
val - the value to add.void lendMessageCountersByType(SrvMonSysMemoryEntityTypeCounters val)
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 'messageCountersByType' 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.
val - the value to add.void lendMessageCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
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.
val - the value to 'lend' to lend.int getMessageCountersByTypeCount()
SrvMonSysMemoryEntityTypeCounters getMessageCountersByTypeAt(int index)
index - The index for which the element is to be returned.XIterator<SrvMonSysMemoryEntityTypeCounters> getMessageCountersByTypeIterator()
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
SrvMonSysMemoryEntityTypeCounters[] getMessageCountersByType()
If the field is not set this method will return null.
null.SrvMonSysMemoryEntityTypeCounters[] getMessageCountersByTypeEmptyIfNull()
null or not set.
null if not set.getMessageCountersByType()SrvMonSysMemoryEntityTypeCounters[] takeMessageCountersByType()
NOTE:
A nested entity reference returned by getMessageCountersByType() 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.
null if the field is not set.void clearMessageCountersByType()
void setCollectionCounters(SrvMonSysMemoryEntityTypeCounters val)
val - The value to set.void lendCollectionCounters(SrvMonSysMemoryEntityTypeCounters val)
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.
val - the value to 'lend' to lend.SrvMonSysMemoryEntityTypeCounters getCollectionCounters()
void getCollectionCountersTo(SrvMonSysMemoryEntityTypeCounters val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryEntityTypeCounters are cleared.
val - the value to copy intoSrvMonSysMemoryEntityTypeCounters.copyInto(SrvMonSysMemoryEntityTypeCounters)SrvMonSysMemoryEntityTypeCounters takeCollectionCounters()
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.
null if the field is not set.boolean hasCollectionCounters()
getCollectionCounters()void clearCollectionCounters()
void setCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
val - The value to set.void setCollectionCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'collectionCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void lendCollectionCountersByTypeFrom(XIterator<SrvMonSysMemoryEntityTypeCounters> val)
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 'collectionCountersByType' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[]) with
a value of null.
val - the values to set.void addCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'collectionCountersByType' 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.
val - the value to add.void lendCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters val)
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 'collectionCountersByType' 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.
val - the value to add.void lendCollectionCountersByType(SrvMonSysMemoryEntityTypeCounters[] val)
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.
val - the value to 'lend' to lend.int getCollectionCountersByTypeCount()
SrvMonSysMemoryEntityTypeCounters getCollectionCountersByTypeAt(int index)
index - The index for which the element is to be returned.XIterator<SrvMonSysMemoryEntityTypeCounters> getCollectionCountersByTypeIterator()
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
SrvMonSysMemoryEntityTypeCounters[] getCollectionCountersByType()
If the field is not set this method will return null.
null.SrvMonSysMemoryEntityTypeCounters[] getCollectionCountersByTypeEmptyIfNull()
null or not set.
null if not set.getCollectionCountersByType()SrvMonSysMemoryEntityTypeCounters[] takeCollectionCountersByType()
NOTE:
A nested entity reference returned by getCollectionCountersByType() 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.
null if the field is not set.void clearCollectionCountersByType()
Copyright © 2019 N5 Technologies, Inc. All Rights Reserved.