@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 ISrvMonGetLoadedAppsResponse extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonGetLoadedAppsResponse>, ISrvMonXvmResponse
| ADM Type | Message |
| Factory | SrvMonCncFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| adminClientId | String | 201 | The admin client targeted in the command exchange. |
| correlationId | Long | 202 | The request correlation ID. |
| loadedApps | SrvMonAppInfo[] | 1 | The list of currently loaded apps. |
| xvmHeader | SrvMonXvmHeader | 6004 | Details about the message source. |
| xvmName | String | 203 | The name of the XVM targeted in the command exchange. |
IRogNode.PoolingListenerIStoreObject.EncodingType| Modifier and Type | Method and Description |
|---|---|
void |
addLoadedApps(SrvMonAppInfo val)
Adds the provided value to the list of 'loadedApps' values.
|
void |
clearAdminClientId()
Clears the value of 'adminClientId'.
|
void |
clearCorrelationId()
Clears the value of 'correlationId'.
|
void |
clearLoadedApps()
Clears the value of 'loadedApps'.
|
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
void |
clearXvmName()
Clears the value of 'xvmName'.
|
SrvMonGetLoadedAppsResponse |
copy()
Creates a copy of this SrvMonGetLoadedAppsResponse.
|
void |
copyInto(SrvMonGetLoadedAppsResponse target)
Copies the contents of this SrvMonGetLoadedAppsResponse into the target.
|
String |
getAdminClientId()
Gets the value of 'adminClientId'.
|
<T extends XString> |
getAdminClientIdTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getAdminClientIdTo(XString val)
Copies the value of 'adminClientId' into the provided XString.
|
XString |
getAdminClientIdUnsafe()
Gets the raw value of 'adminClientId'.
|
long |
getCorrelationId()
Gets the value of 'correlationId'.
|
SrvMonAppInfo[] |
getLoadedApps()
Gets the value of 'loadedApps'.
|
SrvMonAppInfo[] |
getLoadedAppsEmptyIfNull()
Gets the value of 'loadedApps' or an empty array if the value is
null or not set. |
XIterator<SrvMonAppInfo> |
getLoadedAppsIterator()
Gets the value of 'loadedApps' as iterator of values.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
getXvmHeader()
Gets the value of 'xvmHeader'.
|
void |
getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)
Copies the value of SrvMonXvmHeader into the provided value.
|
String |
getXvmName()
Gets the value of 'xvmName'.
|
<T extends XString> |
getXvmNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getXvmNameTo(XString val)
Copies the value of 'xvmName' into the provided XString.
|
XString |
getXvmNameUnsafe()
Gets the raw value of 'xvmName'.
|
boolean |
hasAdminClientId()
Checks for the presence of 'adminClientId'.
|
boolean |
hasCorrelationId()
Checks for the presence of 'correlationId'.
|
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
boolean |
hasXvmName()
Checks for the presence of 'xvmName'.
|
void |
lendAdminClientId(XString val)
Lends the value of 'adminClientId' to this object.
|
void |
lendLoadedApps(SrvMonAppInfo val)
Adds the provided value to the list of 'loadedApps' values and acquires a reference to it.
|
void |
lendLoadedApps(SrvMonAppInfo[] val)
Lends the value of 'loadedApps'.
|
void |
lendLoadedAppsFrom(XIterator<SrvMonAppInfo> val)
Sets the value of 'loadedApps' by lending the values from the provided iterator.
|
void |
lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
'Lends' a reference of the SrvMonXvmHeader to the message for this field.
|
void |
lendXvmName(XString val)
Lends the value of 'xvmName' to this object.
|
void |
setAdminClientId(String val)
Sets the value of 'adminClientId'.
|
void |
setAdminClientIdFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setAdminClientIdFrom(XString val)
Copies the provided XString value into this object's 'adminClientId'.
|
void |
setCorrelationId(long val)
Sets the value of 'correlationId'.
|
void |
setLoadedApps(SrvMonAppInfo[] val)
Sets the value of 'loadedApps'.
|
void |
setLoadedAppsFrom(XIterator<SrvMonAppInfo> val)
Sets the value of 'loadedApps' using the values from the provided iterator.
|
void |
setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
Sets the value of 'xvmHeader'.
|
void |
setXvmName(String val)
Sets the value of 'xvmName'.
|
void |
setXvmNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setXvmNameFrom(XString val)
Copies the provided XString value into this object's 'xvmName'.
|
SrvMonAppInfo[] |
takeLoadedApps()
Takes the value of 'loadedApps'.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
takeXvmHeader()
'Takes' a reference to the xvmHeader field from the message.
|
deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValueensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionIdgetMessageReflectorgetEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToStringvoid setCorrelationId(long val)
setCorrelationId in interface ISrvMonXvmResponseval - The value to set.long getCorrelationId()
getCorrelationId in interface ISrvMonXvmResponsevoid clearCorrelationId()
clearCorrelationId in interface ISrvMonXvmResponsesetCorrelationId(long)boolean hasCorrelationId()
hasCorrelationId in interface ISrvMonXvmResponsegetCorrelationId()void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadersetXvmHeader in interface ISrvMonXvmResponseval - The value to set.void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader 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.
lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderlendXvmHeader in interface ISrvMonXvmResponseval - the value to 'lend' to lend.com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadergetXvmHeader in interface ISrvMonXvmResponsevoid getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)
IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadergetXvmHeaderTo in interface ISrvMonXvmResponseval - the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
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.
takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadertakeXvmHeader in interface ISrvMonXvmResponsenull if the field is not set.boolean hasXvmHeader()
hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderhasXvmHeader in interface ISrvMonXvmResponsegetXvmHeader()void clearXvmHeader()
clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderclearXvmHeader in interface ISrvMonXvmResponsesetXvmHeader(SrvMonXvmHeader)void setAdminClientId(String val)
setAdminClientId in interface ISrvMonXvmResponseval - The value to set.String getAdminClientId()
getAdminClientId in interface ISrvMonXvmResponsevoid lendAdminClientId(XString val)
This method is equivalent to setAdminClientId except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendAdminClientId in interface ISrvMonXvmResponseval - The value to set.IllegalArgumentException - If the value is mutable.void setAdminClientIdFrom(long val)
NOTE:
This is the same as calling setAdminClientId(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAdminClientIdFrom in interface ISrvMonXvmResponse<T extends XString> T getAdminClientIdTo(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;
getAdminClientIdTo in interface ISrvMonXvmResponsefactory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setAdminClientIdFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setAdminClientId(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setAdminClientIdFrom in interface ISrvMonXvmResponsevoid getAdminClientIdTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getAdminClientId() bec
because it can avoid decoding the value into an String.
getAdminClientIdTo in interface ISrvMonXvmResponsegetAdminClientId()XString getAdminClientIdUnsafe()
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.
getAdminClientIdUnsafe in interface ISrvMonXvmResponsegetAdminClientId()void clearAdminClientId()
clearAdminClientId in interface ISrvMonXvmResponsesetAdminClientId(String)boolean hasAdminClientId()
hasAdminClientId in interface ISrvMonXvmResponsegetAdminClientId()void setXvmName(String val)
setXvmName in interface ISrvMonXvmResponseval - The value to set.String getXvmName()
getXvmName in interface ISrvMonXvmResponsevoid lendXvmName(XString val)
This method is equivalent to setXvmName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendXvmName in interface ISrvMonXvmResponseval - The value to set.IllegalArgumentException - If the value is mutable.void setXvmNameFrom(long val)
NOTE:
This is the same as calling setXvmName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setXvmNameFrom in interface ISrvMonXvmResponse<T extends XString> T getXvmNameTo(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;
getXvmNameTo in interface ISrvMonXvmResponsefactory - The factory from which to get the XString to copy into and returnnull.NullPointerException - if the provided factory is nullvoid setXvmNameFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setXvmName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setXvmNameFrom in interface ISrvMonXvmResponsevoid getXvmNameTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getXvmName() bec
because it can avoid decoding the value into an String.
getXvmNameTo in interface ISrvMonXvmResponsegetXvmName()XString getXvmNameUnsafe()
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.
getXvmNameUnsafe in interface ISrvMonXvmResponsegetXvmName()void clearXvmName()
clearXvmName in interface ISrvMonXvmResponsesetXvmName(String)boolean hasXvmName()
hasXvmName in interface ISrvMonXvmResponsegetXvmName()void setLoadedApps(SrvMonAppInfo[] val)
val - The value to set.void setLoadedAppsFrom(XIterator<SrvMonAppInfo> 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 'loadedApps' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setLoadedApps(SrvMonAppInfo[]) with
a value of null.
val - the values to set.void lendLoadedAppsFrom(XIterator<SrvMonAppInfo> 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 'loadedApps' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling setLoadedApps(SrvMonAppInfo[]) with
a value of null.
val - the values to set.void addLoadedApps(SrvMonAppInfo val)
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'loadedApps' 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 lendLoadedApps(SrvMonAppInfo 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 'loadedApps' 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<SrvMonAppInfo> getLoadedAppsIterator()
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 lendLoadedApps(SrvMonAppInfo[] 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.SrvMonAppInfo[] getLoadedApps()
If the field is not set this method will return null.
null.SrvMonAppInfo[] getLoadedAppsEmptyIfNull()
null or not set.
null if not set.getLoadedApps()SrvMonAppInfo[] takeLoadedApps()
NOTE:
A nested entity reference returned by getLoadedApps() 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 clearLoadedApps()
setLoadedApps(SrvMonAppInfo[])SrvMonGetLoadedAppsResponse copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonGetLoadedAppsResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonGetLoadedAppsResponse is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
copy in interface CopyableMessageView<ISrvMonGetLoadedAppsResponse>copy in interface IRogCopyableNode<ISrvMonGetLoadedAppsResponse>IRogCopyableNode,
CopyableMessageViewvoid copyInto(SrvMonGetLoadedAppsResponse target)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonGetLoadedAppsResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonGetLoadedAppsResponse is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
target - The target to copy into which must not be null or read only.Copyright © 2019 Neeve Research, LLC. All Rights Reserved.