|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@Generated(value="com.neeve.adm.AdmGenerator",
date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
admVersion="nvx-adm v3.7.265 (build 0)",
date="3/28/18 10:54 AM",
buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonAppStats
Groups together stats for an application.
| Method Summary | ||
|---|---|---|
void |
addBusBindingStats(SrvMonAppBusBindingStats val)
Adds the provided value to the list of 'busBindingStats' values. |
|
void |
clearAppName()
Clears the value of 'appName' Field Description The application name |
|
void |
clearBusBindingStats()
Clears the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus |
|
void |
clearEngineStats()
Clears the value of 'engineStats' Field Description The application's engine stats |
|
void |
clearEventMultiplexerStats()
Clears the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats |
|
void |
clearStoreBindingStats()
Clears the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats |
|
void |
clearUserStats()
Clears the value of 'userStats' Field Description The application's user defined stats |
|
String |
getAppName()
Gets the value of 'appName' Field Description The application name |
|
|
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'. |
|
SrvMonAppBusBindingStats[] |
getBusBindingStats()
Gets the value of 'busBindingStats' If the field is not set this method will return null. |
|
SrvMonAppBusBindingStats[] |
getBusBindingStatsEmptyIfNull()
Gets the value of 'busBindingStats' or an empty array if the value is null or not set. |
|
XIterator<SrvMonAppBusBindingStats> |
getBusBindingStatsIterator()
Gets the value of 'busBindingStats' as iterator of values. |
|
SrvMonAppEngineStats |
getEngineStats()
Gets the value of 'engineStats' Field Description The application's engine stats |
|
void |
getEngineStatsTo(SrvMonAppEngineStats val)
Copies the value of SrvMonAppEngineStats into the provided value. |
|
SrvMonAppEventMultiplexerStats |
getEventMultiplexerStats()
Gets the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats |
|
void |
getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats val)
Copies the value of SrvMonAppEventMultiplexerStats into the provided value. |
|
SrvMonAppStoreBindingStats |
getStoreBindingStats()
Gets the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats |
|
void |
getStoreBindingStatsTo(SrvMonAppStoreBindingStats val)
Copies the value of SrvMonAppStoreBindingStats into the provided value. |
|
SrvMonUserStats |
getUserStats()
Gets the value of 'userStats' Field Description The application's user defined stats |
|
void |
getUserStatsTo(SrvMonUserStats val)
Copies the value of SrvMonUserStats into the provided value. |
|
boolean |
hasAppName()
Checks for the presence of 'appName' Field Description The application name |
|
boolean |
hasEngineStats()
Checks for the presence of 'engineStats' Field Description The application's engine stats |
|
boolean |
hasEventMultiplexerStats()
Checks for the presence of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats |
|
boolean |
hasStoreBindingStats()
Checks for the presence of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats |
|
boolean |
hasUserStats()
Checks for the presence of 'userStats' Field Description The application's user defined stats |
|
void |
lendAppName(XString val)
Sets the value of 'appName' Field Description The application name |
|
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' Field Description The applications messaging stats for each configured bus NOTE: It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. |
|
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. |
|
void |
setAppName(String val)
Sets the value of 'appName' Field Description The application name |
|
void |
setAppNameFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setAppNameFrom(XString val)
Copies the provided XString value into this object's 'appName'. |
|
void |
setBusBindingStats(SrvMonAppBusBindingStats[] val)
Sets the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus |
|
void |
setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> val)
Sets the value of 'busBindingStats' using the values from the provided iterator. |
|
void |
setEngineStats(SrvMonAppEngineStats val)
Sets the value of 'engineStats' Field Description The application's engine stats |
|
void |
setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
Sets the value of 'eventMultiplexerStats' Field Description The application's input event multiplexer stats |
|
void |
setStoreBindingStats(SrvMonAppStoreBindingStats val)
Sets the value of 'storeBindingStats' Field Description The application's replication and persistent disk storage stats |
|
void |
setUserStats(SrvMonUserStats val)
Sets the value of 'userStats' Field Description The application's user defined stats |
|
SrvMonAppBusBindingStats[] |
takeBusBindingStats()
Takes the value of 'busBindingStats' Field Description The applications messaging stats for each configured bus NOTE: A nested entity reference returned by 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. |
|
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. |
|
| Methods inherited from interface com.neeve.rog.IRogValidatable |
|---|
getValidationErrors, isValid |
| Method Detail |
|---|
void setAppName(String val)
val - The value to set.String getAppName()
void lendAppName(XString val)
val - The value to set.void setAppNameFrom(long val)
NOTE:
This is the same as calling setAppName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getAppNameTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setAppNameFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setAppName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getAppNameTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getAppName() bec
because it can avoid decoding the value into an String.
getAppName()XString getAppNameUnsafe()
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.
getAppName()void clearAppName()
setAppName(String)boolean hasAppName()
getAppName()void setEngineStats(SrvMonAppEngineStats val)
val - The value to set.void lendEngineStats(SrvMonAppEngineStats 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.SrvMonAppEngineStats getEngineStats()
void getEngineStatsTo(SrvMonAppEngineStats val)
IF the value is not set, then the contents of the provided SrvMonAppEngineStats are cleared.
val - the value to copy intoSrvMonAppEngineStats.copyInto(SrvMonAppEngineStats)SrvMonAppEngineStats takeEngineStats()
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 hasEngineStats()
getEngineStats()void clearEngineStats()
setEngineStats(SrvMonAppEngineStats)void setEventMultiplexerStats(SrvMonAppEventMultiplexerStats val)
val - The value to set.void lendEventMultiplexerStats(SrvMonAppEventMultiplexerStats 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.SrvMonAppEventMultiplexerStats getEventMultiplexerStats()
void getEventMultiplexerStatsTo(SrvMonAppEventMultiplexerStats val)
IF the value is not set, then the contents of the provided SrvMonAppEventMultiplexerStats are cleared.
val - the value to copy intoSrvMonAppEventMultiplexerStats.copyInto(SrvMonAppEventMultiplexerStats)SrvMonAppEventMultiplexerStats takeEventMultiplexerStats()
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 hasEventMultiplexerStats()
getEventMultiplexerStats()void clearEventMultiplexerStats()
setEventMultiplexerStats(SrvMonAppEventMultiplexerStats)void setStoreBindingStats(SrvMonAppStoreBindingStats val)
val - The value to set.void lendStoreBindingStats(SrvMonAppStoreBindingStats 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.SrvMonAppStoreBindingStats getStoreBindingStats()
void getStoreBindingStatsTo(SrvMonAppStoreBindingStats val)
IF the value is not set, then the contents of the provided SrvMonAppStoreBindingStats are cleared.
val - the value to copy intoSrvMonAppStoreBindingStats.copyInto(SrvMonAppStoreBindingStats)SrvMonAppStoreBindingStats takeStoreBindingStats()
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 hasStoreBindingStats()
getStoreBindingStats()void clearStoreBindingStats()
setStoreBindingStats(SrvMonAppStoreBindingStats)void setBusBindingStats(SrvMonAppBusBindingStats[] val)
val - The value to set.void setBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> 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 'busBindingStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setBusBindingStats(SrvMonAppBusBindingStats[]) with
a value of null.
val - the values to set.void lendBusBindingStatsFrom(XIterator<SrvMonAppBusBindingStats> 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 'busBindingStats' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setBusBindingStats(SrvMonAppBusBindingStats[]) with
a value of null.
val - the values to set.void addBusBindingStats(SrvMonAppBusBindingStats val)
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.
val - the value to add.void lendBusBindingStats(SrvMonAppBusBindingStats 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 '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.
val - the value to add.XIterator<SrvMonAppBusBindingStats> getBusBindingStatsIterator()
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 this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).
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 lendBusBindingStats(SrvMonAppBusBindingStats[] 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.SrvMonAppBusBindingStats[] getBusBindingStats()
If the field is not set this method will return null.
null.SrvMonAppBusBindingStats[] getBusBindingStatsEmptyIfNull()
null or not set.
null if not set.getBusBindingStats()SrvMonAppBusBindingStats[] takeBusBindingStats()
NOTE:
A nested entity reference returned by 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.
null if the field is not set.void clearBusBindingStats()
setBusBindingStats(SrvMonAppBusBindingStats[])void setUserStats(SrvMonUserStats val)
val - The value to set.void lendUserStats(SrvMonUserStats 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.SrvMonUserStats getUserStats()
void getUserStatsTo(SrvMonUserStats val)
IF the value is not set, then the contents of the provided SrvMonUserStats are cleared.
val - the value to copy intoSrvMonUserStats.copyInto(SrvMonUserStats)SrvMonUserStats takeUserStats()
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 hasUserStats()
getUserStats()void clearUserStats()
setUserStats(SrvMonUserStats)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||