@Generated(value="com.neeve.adm.AdmGenerator", date="Thu May 07 15:37:32 EDT 2020") @AdmGenerated(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)") public interface ISrvMonSysStats extends IRogValidatable
| ADM Type | Embedded Entity |
| Factory | SrvMonFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| availableProcessors | Integer | 1 | The number of processors available to the Java virtual machine. |
| diskStats | SrvMonSysDiskStats[] | 7 | Holds disk related stats. |
| gcStats | SrvMonSysGCStats |
4 | Holds GC related stats. |
| jitStats | SrvMonSysJITStats |
5 | Holds JIT (Just In Time compiler) related stats. |
| memoryStats | SrvMonSysMemoryStats |
3 | Holds memory related stats. |
| processCpuLoad | Double | 8 | Holds recent cpu usage by the process (on a 0.0 to 1.0 scale). |
| systemCpuLoad | Double | 9 | Holds recent cpu usage by the system (on a 0.0 to 1.0 scale). |
| systemLoadAverage | Double | 2 | The system load average for the last minute. |
| threadStats | SrvMonSysThreadStats |
6 | Holds thread related stats. |
| Modifier and Type | Method and Description |
|---|---|
void |
addDiskStats(SrvMonSysDiskStats val)
Adds the provided value to the list of 'diskStats' values.
|
void |
clearAvailableProcessors()
Clears the value of 'availableProcessors'.
|
void |
clearDiskStats()
Clears the value of 'diskStats'.
|
void |
clearGcStats()
Clears the value of 'gcStats'.
|
void |
clearJitStats()
Clears the value of 'jitStats'.
|
void |
clearMemoryStats()
Clears the value of 'memoryStats'.
|
void |
clearProcessCpuLoad()
Clears the value of 'processCpuLoad'.
|
void |
clearSystemCpuLoad()
Clears the value of 'systemCpuLoad'.
|
void |
clearSystemLoadAverage()
Clears the value of 'systemLoadAverage'.
|
void |
clearThreadStats()
Clears the value of 'threadStats'.
|
int |
getAvailableProcessors()
Gets the value of 'availableProcessors'.
|
SrvMonSysDiskStats[] |
getDiskStats()
Gets the value of 'diskStats'.
|
SrvMonSysDiskStats[] |
getDiskStatsEmptyIfNull()
Gets the value of 'diskStats' or an empty array if the value is
null or not set. |
XIterator<SrvMonSysDiskStats> |
getDiskStatsIterator()
Gets the value of 'diskStats' as iterator of values.
|
SrvMonSysGCStats |
getGcStats()
Gets the value of 'gcStats'.
|
void |
getGcStatsTo(SrvMonSysGCStats val)
Copies the value of SrvMonSysGCStats into the provided value.
|
SrvMonSysJITStats |
getJitStats()
Gets the value of 'jitStats'.
|
void |
getJitStatsTo(SrvMonSysJITStats val)
Copies the value of SrvMonSysJITStats into the provided value.
|
SrvMonSysMemoryStats |
getMemoryStats()
Gets the value of 'memoryStats'.
|
void |
getMemoryStatsTo(SrvMonSysMemoryStats val)
Copies the value of SrvMonSysMemoryStats into the provided value.
|
double |
getProcessCpuLoad()
Gets the value of 'processCpuLoad'.
|
double |
getSystemCpuLoad()
Gets the value of 'systemCpuLoad'.
|
double |
getSystemLoadAverage()
Gets the value of 'systemLoadAverage'.
|
SrvMonSysThreadStats |
getThreadStats()
Gets the value of 'threadStats'.
|
void |
getThreadStatsTo(SrvMonSysThreadStats val)
Copies the value of SrvMonSysThreadStats into the provided value.
|
boolean |
hasAvailableProcessors()
Checks for the presence of 'availableProcessors'.
|
boolean |
hasGcStats()
Checks for the presence of 'gcStats'.
|
boolean |
hasJitStats()
Checks for the presence of 'jitStats'.
|
boolean |
hasMemoryStats()
Checks for the presence of 'memoryStats'.
|
boolean |
hasProcessCpuLoad()
Checks for the presence of 'processCpuLoad'.
|
boolean |
hasSystemCpuLoad()
Checks for the presence of 'systemCpuLoad'.
|
boolean |
hasSystemLoadAverage()
Checks for the presence of 'systemLoadAverage'.
|
boolean |
hasThreadStats()
Checks for the presence of 'threadStats'.
|
void |
lendDiskStats(SrvMonSysDiskStats val)
Adds the provided value to the list of 'diskStats' values and acquires a reference to it.
|
void |
lendDiskStats(SrvMonSysDiskStats[] val)
Lends the value of 'diskStats'.
|
void |
lendDiskStatsFrom(XIterator<SrvMonSysDiskStats> val)
Sets the value of 'diskStats' by lending the values from the provided iterator.
|
void |
lendGcStats(SrvMonSysGCStats val)
'Lends' a reference of the SrvMonSysGCStats to the message for this field.
|
void |
lendJitStats(SrvMonSysJITStats val)
'Lends' a reference of the SrvMonSysJITStats to the message for this field.
|
void |
lendMemoryStats(SrvMonSysMemoryStats val)
'Lends' a reference of the SrvMonSysMemoryStats to the message for this field.
|
void |
lendThreadStats(SrvMonSysThreadStats val)
'Lends' a reference of the SrvMonSysThreadStats to the message for this field.
|
void |
setAvailableProcessors(int val)
Sets the value of 'availableProcessors'.
|
void |
setDiskStats(SrvMonSysDiskStats[] val)
Sets the value of 'diskStats'.
|
void |
setDiskStatsFrom(XIterator<SrvMonSysDiskStats> val)
Sets the value of 'diskStats' using the values from the provided iterator.
|
void |
setGcStats(SrvMonSysGCStats val)
Sets the value of 'gcStats'.
|
void |
setJitStats(SrvMonSysJITStats val)
Sets the value of 'jitStats'.
|
void |
setMemoryStats(SrvMonSysMemoryStats val)
Sets the value of 'memoryStats'.
|
void |
setProcessCpuLoad(double val)
Sets the value of 'processCpuLoad'.
|
void |
setSystemCpuLoad(double val)
Sets the value of 'systemCpuLoad'.
|
void |
setSystemLoadAverage(double val)
Sets the value of 'systemLoadAverage'.
|
void |
setThreadStats(SrvMonSysThreadStats val)
Sets the value of 'threadStats'.
|
SrvMonSysDiskStats[] |
takeDiskStats()
Takes the value of 'diskStats'.
|
SrvMonSysGCStats |
takeGcStats()
'Takes' a reference to the gcStats field from the message.
|
SrvMonSysJITStats |
takeJitStats()
'Takes' a reference to the jitStats field from the message.
|
SrvMonSysMemoryStats |
takeMemoryStats()
'Takes' a reference to the memoryStats field from the message.
|
SrvMonSysThreadStats |
takeThreadStats()
'Takes' a reference to the threadStats field from the message.
|
getValidationErrors, isValidvoid setAvailableProcessors(int val)
val - The value to set.int getAvailableProcessors()
void clearAvailableProcessors()
setAvailableProcessors(int)boolean hasAvailableProcessors()
getAvailableProcessors()void setSystemLoadAverage(double val)
val - The value to set.double getSystemLoadAverage()
void clearSystemLoadAverage()
setSystemLoadAverage(double)boolean hasSystemLoadAverage()
getSystemLoadAverage()void setProcessCpuLoad(double val)
val - The value to set.double getProcessCpuLoad()
void clearProcessCpuLoad()
setProcessCpuLoad(double)boolean hasProcessCpuLoad()
getProcessCpuLoad()void setSystemCpuLoad(double val)
val - The value to set.double getSystemCpuLoad()
void clearSystemCpuLoad()
setSystemCpuLoad(double)boolean hasSystemCpuLoad()
getSystemCpuLoad()void setMemoryStats(SrvMonSysMemoryStats val)
val - The value to set.void lendMemoryStats(SrvMonSysMemoryStats 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.SrvMonSysMemoryStats getMemoryStats()
void getMemoryStatsTo(SrvMonSysMemoryStats val)
IF the value is not set, then the contents of the provided SrvMonSysMemoryStats are cleared.
val - the value to copy intoSrvMonSysMemoryStats.copyInto(SrvMonSysMemoryStats)SrvMonSysMemoryStats takeMemoryStats()
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 hasMemoryStats()
getMemoryStats()void clearMemoryStats()
setMemoryStats(SrvMonSysMemoryStats)void setGcStats(SrvMonSysGCStats val)
val - The value to set.void lendGcStats(SrvMonSysGCStats 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.SrvMonSysGCStats getGcStats()
void getGcStatsTo(SrvMonSysGCStats val)
IF the value is not set, then the contents of the provided SrvMonSysGCStats are cleared.
val - the value to copy intoSrvMonSysGCStats.copyInto(SrvMonSysGCStats)SrvMonSysGCStats takeGcStats()
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 hasGcStats()
getGcStats()void clearGcStats()
setGcStats(SrvMonSysGCStats)void setJitStats(SrvMonSysJITStats val)
val - The value to set.void lendJitStats(SrvMonSysJITStats 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.SrvMonSysJITStats getJitStats()
void getJitStatsTo(SrvMonSysJITStats val)
IF the value is not set, then the contents of the provided SrvMonSysJITStats are cleared.
val - the value to copy intoSrvMonSysJITStats.copyInto(SrvMonSysJITStats)SrvMonSysJITStats takeJitStats()
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 hasJitStats()
getJitStats()void clearJitStats()
setJitStats(SrvMonSysJITStats)void setThreadStats(SrvMonSysThreadStats val)
val - The value to set.void lendThreadStats(SrvMonSysThreadStats 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.SrvMonSysThreadStats getThreadStats()
void getThreadStatsTo(SrvMonSysThreadStats val)
IF the value is not set, then the contents of the provided SrvMonSysThreadStats are cleared.
val - the value to copy intoSrvMonSysThreadStats.copyInto(SrvMonSysThreadStats)SrvMonSysThreadStats takeThreadStats()
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 hasThreadStats()
getThreadStats()void clearThreadStats()
setThreadStats(SrvMonSysThreadStats)void setDiskStats(SrvMonSysDiskStats[] val)
val - The value to set.void setDiskStatsFrom(XIterator<SrvMonSysDiskStats> 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 'diskStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setDiskStats(SrvMonSysDiskStats[]) with
a value of null.
val - the values to set.void lendDiskStatsFrom(XIterator<SrvMonSysDiskStats> 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 'diskStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setDiskStats(SrvMonSysDiskStats[]) with
a value of null.
val - the values to set.void addDiskStats(SrvMonSysDiskStats val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'diskStats' 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 lendDiskStats(SrvMonSysDiskStats 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 'diskStats' 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.XIterator<SrvMonSysDiskStats> getDiskStatsIterator()
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
void lendDiskStats(SrvMonSysDiskStats[] 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.SrvMonSysDiskStats[] getDiskStats()
If the field is not set this method will return null.
null.SrvMonSysDiskStats[] getDiskStatsEmptyIfNull()
null or not set.
null if not set.getDiskStats()SrvMonSysDiskStats[] takeDiskStats()
NOTE:
A nested entity reference returned by getDiskStats() 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 clearDiskStats()
setDiskStats(SrvMonSysDiskStats[])Copyright © 2019 Neeve Research, LLC. All Rights Reserved.