@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Fri Dec 05 13:32:50 UTC 2025") @AdmGenerated(encoding="Xbuf", compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 1:32 PM", buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)") @AdmFactoryInfo(factoryClass=SrvMonCncFactory.class, vfid=36, ofid=36, typeId=2) public final class SrvMonListCommandsResponse extends com.neeve.rog.impl.RogNode implements ISrvMonListCommandsResponse, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable
| ADM Type | Message |
| Factory | SrvMonCncFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| adminClientId | String | 216 | The admin client targeted in the command exchange. |
| commands | SrvMonCommandDescription[] | 16 | No doc provided. |
| correlationId | Long | 217 | The request correlation ID. |
| xvmHeader | SrvMonXvmHeader | 6019 | Details about the message source. |
| xvmName | String | 218 | The name of the XVM targeted in the command exchange. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonListCommandsResponse.PacketBody
The backing packet type for SrvMonListCommandsResponse (used internally for serialization purposes).
|
IRogNode.PoolingListenerIStoreObject.EncodingType| Modifier and Type | Field and Description |
|---|---|
static SrvMonListCommandsResponse[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
count, head, next, prev| Modifier and Type | Method and Description |
|---|---|
void |
addCommands(SrvMonCommandDescription val)
Adds the provided value to the list of 'commands' values.
|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target)
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Appends a reflected field value as a string into the given XString.
|
void |
clearAdminClientId()
Clears the value of 'adminClientId'.
|
void |
clearCommands()
Clears the value of 'commands'.
|
void |
clearContent() |
void |
clearCorrelationId()
Clears the value of 'correlationId'.
|
void |
clearXRogType() |
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
void |
clearXvmName()
Clears the value of 'xvmName'.
|
SrvMonListCommandsResponse |
copy()
Creates a copy of this SrvMonListCommandsResponse.
|
void |
copyInto(SrvMonListCommandsResponse copy)
Copies the contents of this SrvMonListCommandsResponse into the target.
|
static SrvMonListCommandsResponse |
create() |
static SrvMonListCommandsResponse |
create(com.eaio.uuid.UUID id) |
static SrvMonListCommandsResponse |
createFrom(byte[] serializedContainer) |
static SrvMonListCommandsResponse |
createFrom(ByteBuffer serializedContainer) |
static SrvMonListCommandsResponse |
createFromJson(String json) |
static SrvMonListCommandsResponse |
createFromRawJson(String json) |
static SrvMonListCommandsResponse |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonListCommandsResponse |
createFromSerializedXbufContainer(ByteBuffer serializedContainer) |
static SrvMonListCommandsResponse |
createFromSerializedXbufContainerPacket(byte[] serializedPacket) |
static SrvMonListCommandsResponse |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) |
static SrvMonListCommandsResponse |
createFromXbufContainerPacket(PktPacket packet) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonListCommandsResponse |
deserialize(PktPacket packet)
Deserialize an object's data.
|
SrvMonListCommandsResponse |
deserializeFromByteArray(byte[] array)
Deserialize a view's backing message from a byte array.
|
SrvMonListCommandsResponse |
deserializeFromByteBuffer(ByteBuffer buffer)
Deserialize a view's backing message from a byte buffer.
|
SrvMonListCommandsResponse |
deserializeFromJson(String json)
Deserialize a view's backing message from a json string
|
SrvMonListCommandsResponse |
deserializeFromPacket(PktPacket packet)
Deserialize a view's backing message from a packet.
|
SrvMonListCommandsResponse |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deserialize a node's data from a protobuf message.
|
SrvMonListCommandsResponse |
deserializeFromRawJson(String json) |
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
Desync fields from a buffer
|
void |
desyncFieldBitmask() |
int |
dispose()
Implementation of
IRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. |
boolean |
fieldExists(Object message,
String name)
Check if a field of the supplied name exists in a message.
|
String |
getAdminClientId()
Gets the value of 'adminClientId'.
|
com.neeve.xbuf.XbufStringField |
getAdminClientIdField() |
static int |
getAdminClientIdFieldId() |
<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'.
|
PktBuffer |
getBackingBuffer() |
SrvMonCommandDescription[] |
getCommands()
Gets the value of 'commands'.
|
SrvMonCommandDescription[] |
getCommandsEmptyIfNull()
Gets the value of 'commands' or an empty array if the value is
null or not set. |
static int |
getCommandsFieldId() |
XIterator<SrvMonCommandDescription> |
getCommandsIterator()
Gets the value of 'commands' as iterator of values.
|
IStoreObject.EncodingType |
getContentEncodingType()
Get an object's content data encoding type.
|
long |
getCorrelationId()
Gets the value of 'correlationId'.
|
Long |
getCorrelationIdAsObject()
Gets the value of 'correlationId'.
|
com.neeve.xbuf.XbufVariableLongField |
getCorrelationIdField() |
static int |
getCorrelationIdFieldId() |
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
XString |
getFieldValueAsRawString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Get the value of a reflectable field in a message as a string.
|
PktPacket |
getPacket()
Return the packet tied to this message.
|
short |
getXRogType() |
Short |
getXRogTypeAsObject() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
com.neeve.server.mon.common.SrvMonXvmHeader |
getXvmHeader()
Gets the value of 'xvmHeader'.
|
static int |
getXvmHeaderFieldId() |
void |
getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
Copies the value of SrvMonXvmHeader into the provided value.
|
String |
getXvmName()
Gets the value of 'xvmName'.
|
com.neeve.xbuf.XbufStringField |
getXvmNameField() |
static int |
getXvmNameFieldId() |
<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 |
hasXRogType() |
boolean |
hasXvmHeader()
Checks for the presence of 'xvmHeader'.
|
boolean |
hasXvmName()
Checks for the presence of 'xvmName'.
|
boolean |
isDirty() |
boolean |
isFieldReflectable(Object message,
String name)
Check if a field of the supplied name is reflectable.
|
void |
lendAdminClientId(XString val)
Lends the value of 'adminClientId' to this object.
|
void |
lendCommands(SrvMonCommandDescription val)
Adds the provided value to the list of 'commands' values and acquires a reference to it.
|
void |
lendCommands(SrvMonCommandDescription[] val)
Lends the value of 'commands'.
|
void |
lendCommandsFrom(XIterator<SrvMonCommandDescription> val)
Sets the value of 'commands' 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.
|
boolean |
needsSync()
Check if a view needs to be sync'd for reflection.
|
static void |
optimizeFor(int val) |
PktPacket |
serialize()
Serialize an object's data.
|
byte[] |
serializeToByteArray()
Serialize a view's backing message to a byte array.
|
ByteBuffer |
serializeToByteBuffer()
Serialize a view's backing message to a byte buffer.
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
Default implementation of
MessageView.serializeToIOBuffer(boolean) |
String |
serializeToJson()
Serialize a view's backing message to JSON.
|
PktPacket |
serializeToPacket()
Serialize a view's backing message to a packet.
|
com.google.protobuf.Message |
serializeToProtobuf()
Serialize a node's data to a proto message.
|
String |
serializeToRawJson() |
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(com.neeve.xbuf.XbufStringField val) |
void |
setAdminClientIdFrom(XString val)
Copies the provided XString value into this object's 'adminClientId'.
|
void |
setAsReadOnly()
Implementation of
IRogNode.setAsReadOnly() |
void |
setCommands(SrvMonCommandDescription[] val)
Sets the value of 'commands'.
|
void |
setCommandsFrom(XIterator<SrvMonCommandDescription> val)
Sets the value of 'commands' using the values from the provided iterator.
|
void |
setCorrelationId(long val)
Sets the value of 'correlationId'.
|
void |
setCorrelationIdAsObject(Long val)
Sets the value of 'correlationId'.
|
void |
setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val) |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
static void |
setFieldInterest(List<Integer> fieldIds) |
IStoreObject |
setFieldValue(int id,
Object val) |
void |
setPreserializedFields(PktBuffer buffer) |
void |
setXRogType(short val) |
void |
setXRogTypeAsObject(Short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
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(com.neeve.xbuf.XbufStringField val) |
void |
setXvmNameFrom(XString val)
Copies the provided XString value into this object's 'xvmName'.
|
void |
sync()
Ensure a view's backing message is prepared and ready for transport
|
void |
syncFieldBitmask() |
SrvMonCommandDescription[] |
takeCommands()
Takes the value of 'commands'.
|
com.neeve.server.mon.common.SrvMonXvmHeader |
takeXvmHeader()
'Takes' a reference to the xvmHeader field from the message.
|
String |
toJsonString()
Get a JSON representation of an ROG entity
|
String |
toJsonString(boolean includeMetadata,
String metadataObjectName,
String payloadObjectName)
Get a full JSON representation of an ROG entity
|
String |
toString()
Return a string representation of an ROG node.
|
void |
undispose(com.eaio.uuid.UUID id)
Recuscitate a disposed node.
|
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getStoreMetadata, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, resolveMessageKeyWith, resolveMessageKeyWith, saveMemory, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCommittedDataSize, setCreateTs, setEnqueueTsMicros, setFieldValue, setGraphId, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setMessageTransportHeaders, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, setTagcount, insertAfter, insertBefore, isLinked, next, previous, unlink, wipeequals, getClass, hashCode, notify, notifyAll, wait, wait, waitdump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, 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, metadataToStringpublic static final SrvMonListCommandsResponse[] EMPTY_ARRAY
public static SrvMonListCommandsResponse create()
public static SrvMonListCommandsResponse create(com.eaio.uuid.UUID id)
public static SrvMonListCommandsResponse createFromXbufContainerPacket(PktPacket packet)
public static SrvMonListCommandsResponse createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonListCommandsResponse createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonListCommandsResponse createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonListCommandsResponse createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonListCommandsResponse createFromRawJson(String json)
public static SrvMonListCommandsResponse createFromJson(String json)
public static SrvMonListCommandsResponse createFrom(ByteBuffer serializedContainer)
public static SrvMonListCommandsResponse createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final PktPacket getPacket()
com.neeve.link.ILnkMessagegetPacket in interface com.neeve.link.ILnkMessagepublic final com.google.protobuf.Message serializeToProtobuf()
IRogNodeserializeToProtobuf in interface IRogNodepublic final String serializeToRawJson()
public final String serializeToJson()
MessageViewserializeToJson in interface MessageViewpublic final SrvMonListCommandsResponse deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNodedeserializeFromProtobuf in interface IRogNodemessage - The protobuf messagepublic final SrvMonListCommandsResponse deserializeFromRawJson(String json)
public final SrvMonListCommandsResponse deserializeFromJson(String json)
MessageViewdeserializeFromJson in interface MessageViewjson - The string containing the json serialized form of the messagepublic final void setAsReadOnly()
com.neeve.rog.impl.RogNodeIRogNode.setAsReadOnly()setAsReadOnly in interface IRogNodesetAsReadOnly in class com.neeve.rog.impl.RogNodepublic int dispose()
com.neeve.rog.impl.RogNodeIRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. When this
disposed, nodes release their reference to their backing packet (if a
node is not backed by a packet, the this method does nothing and the
node is released for garbage collection). The reference release will
cause the packet to ultimately enter into its pool (if a poolable
packet type). Since nodes are tagged to packets (via TAG_ROG_ENVELOPE),
nodes implictly also get pooled. To resuscitate a disposed node, the
user should get the node from its packet and invoke RogNode.undispose(com.eaio.uuid.UUID)
dispose in interface IStoreObjectdispose in interface IRogNodedispose in interface MessageViewdispose in class com.neeve.rog.impl.RogNodepublic void undispose(com.eaio.uuid.UUID id)
com.neeve.rog.impl.RogNodeundispose in class com.neeve.rog.impl.RogNodeid - The resuscitated node's id.
This method should be called to resuscitate a disposed node. Since the caller must release all references to a disposed node, the only place a disposed node can be obtained from is its pooled backing packet container. Upon retrieving a packet from a pool, the user should obtain the node from the TAG_ROG_ENVELOPE packet tag. If the tag is non-null, then it refers to an ROG node object. The user should invoke this method on the node before using the node.
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final void setXRogTypeAsObject(Short val)
public final short getXRogType()
public final Short getXRogTypeAsObject()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getCorrelationIdFieldId()
public final void setCorrelationId(long val)
ISrvMonListCommandsResponsesetCorrelationId in interface ISrvMonListCommandsResponsesetCorrelationId in interface ISrvMonXvmResponseval - The value to set.public final void setCorrelationIdAsObject(Long val)
ISrvMonListCommandsResponsesetCorrelationIdAsObject in interface ISrvMonListCommandsResponsesetCorrelationIdAsObject in interface ISrvMonXvmResponseval - The value to set.public final long getCorrelationId()
ISrvMonListCommandsResponsegetCorrelationId in interface ISrvMonListCommandsResponsegetCorrelationId in interface ISrvMonXvmResponsepublic final Long getCorrelationIdAsObject()
ISrvMonListCommandsResponsegetCorrelationIdAsObject in interface ISrvMonListCommandsResponsegetCorrelationIdAsObject in interface ISrvMonXvmResponsepublic final void setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getCorrelationIdField()
public final boolean hasCorrelationId()
ISrvMonListCommandsResponsehasCorrelationId in interface ISrvMonListCommandsResponsehasCorrelationId in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getCorrelationId()public final void clearCorrelationId()
ISrvMonListCommandsResponseclearCorrelationId in interface ISrvMonListCommandsResponseclearCorrelationId in interface ISrvMonXvmResponseISrvMonListCommandsResponse.setCorrelationId(long)public static final int getXvmHeaderFieldId()
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonListCommandsResponsesetXvmHeader in interface ISrvMonListCommandsResponsesetXvmHeader in interface ISrvMonXvmResponsesetXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderval - The value to set.public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponselendXvmHeader in interface ISrvMonXvmResponselendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderval - the value to 'lend' to lend.public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
ISrvMonListCommandsResponsegetXvmHeader in interface ISrvMonListCommandsResponsegetXvmHeader in interface ISrvMonXvmResponsegetXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderpublic final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
ISrvMonListCommandsResponseIF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo in interface ISrvMonListCommandsResponsegetXvmHeaderTo in interface ISrvMonXvmResponsegetXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderto - the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponsetakeXvmHeader in interface ISrvMonXvmResponsetakeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeadernull if the field is not set.public final boolean hasXvmHeader()
ISrvMonListCommandsResponsehasXvmHeader in interface ISrvMonListCommandsResponsehasXvmHeader in interface ISrvMonXvmResponsehasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderISrvMonListCommandsResponse.getXvmHeader()public final void clearXvmHeader()
ISrvMonListCommandsResponseclearXvmHeader in interface ISrvMonListCommandsResponseclearXvmHeader in interface ISrvMonXvmResponseclearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeaderISrvMonListCommandsResponse.setXvmHeader(SrvMonXvmHeader)public static final int getAdminClientIdFieldId()
public final void setAdminClientId(String val)
ISrvMonListCommandsResponsesetAdminClientId in interface ISrvMonListCommandsResponsesetAdminClientId in interface ISrvMonXvmResponseval - The value to set.public final String getAdminClientId()
ISrvMonListCommandsResponsegetAdminClientId in interface ISrvMonListCommandsResponsegetAdminClientId in interface ISrvMonXvmResponsepublic final void lendAdminClientId(XString val)
ISrvMonListCommandsResponseThis 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 ISrvMonListCommandsResponselendAdminClientId in interface ISrvMonXvmResponseval - The value to set.public final void setAdminClientIdFrom(long val)
ISrvMonListCommandsResponse
NOTE:
This is the same as calling ISrvMonListCommandsResponse.setAdminClientId(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAdminClientIdFrom in interface ISrvMonListCommandsResponsesetAdminClientIdFrom in interface ISrvMonXvmResponsepublic final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponsegetAdminClientIdTo in interface ISrvMonXvmResponsefactory - The factory from which to get the XString to copy into and returnnull.public final void setAdminClientIdFrom(XString val)
ISrvMonListCommandsResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonListCommandsResponse.setAdminClientId(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setAdminClientIdFrom in interface ISrvMonListCommandsResponsesetAdminClientIdFrom in interface ISrvMonXvmResponsepublic final void getAdminClientIdTo(XString val)
ISrvMonListCommandsResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonListCommandsResponse.getAdminClientId() bec
because it can avoid decoding the value into an String.
getAdminClientIdTo in interface ISrvMonListCommandsResponsegetAdminClientIdTo in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getAdminClientId()public final XString getAdminClientIdUnsafe()
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponsegetAdminClientIdUnsafe in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getAdminClientId()public final void setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getAdminClientIdField()
public final boolean hasAdminClientId()
ISrvMonListCommandsResponsehasAdminClientId in interface ISrvMonListCommandsResponsehasAdminClientId in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getAdminClientId()public final void clearAdminClientId()
ISrvMonListCommandsResponseclearAdminClientId in interface ISrvMonListCommandsResponseclearAdminClientId in interface ISrvMonXvmResponseISrvMonListCommandsResponse.setAdminClientId(String)public static final int getXvmNameFieldId()
public final void setXvmName(String val)
ISrvMonListCommandsResponsesetXvmName in interface ISrvMonListCommandsResponsesetXvmName in interface ISrvMonXvmResponseval - The value to set.public final String getXvmName()
ISrvMonListCommandsResponsegetXvmName in interface ISrvMonListCommandsResponsegetXvmName in interface ISrvMonXvmResponsepublic final void lendXvmName(XString val)
ISrvMonListCommandsResponseThis 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 ISrvMonListCommandsResponselendXvmName in interface ISrvMonXvmResponseval - The value to set.public final void setXvmNameFrom(long val)
ISrvMonListCommandsResponse
NOTE:
This is the same as calling ISrvMonListCommandsResponse.setXvmName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setXvmNameFrom in interface ISrvMonListCommandsResponsesetXvmNameFrom in interface ISrvMonXvmResponsepublic final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponsegetXvmNameTo in interface ISrvMonXvmResponsefactory - The factory from which to get the XString to copy into and returnnull.public final void setXvmNameFrom(XString val)
ISrvMonListCommandsResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonListCommandsResponse.setXvmName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setXvmNameFrom in interface ISrvMonListCommandsResponsesetXvmNameFrom in interface ISrvMonXvmResponsepublic final void getXvmNameTo(XString val)
ISrvMonListCommandsResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonListCommandsResponse.getXvmName() bec
because it can avoid decoding the value into an String.
getXvmNameTo in interface ISrvMonListCommandsResponsegetXvmNameTo in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getXvmName()public final XString getXvmNameUnsafe()
ISrvMonListCommandsResponse
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 ISrvMonListCommandsResponsegetXvmNameUnsafe in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getXvmName()public final void setXvmNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getXvmNameField()
public final boolean hasXvmName()
ISrvMonListCommandsResponsehasXvmName in interface ISrvMonListCommandsResponsehasXvmName in interface ISrvMonXvmResponseISrvMonListCommandsResponse.getXvmName()public final void clearXvmName()
ISrvMonListCommandsResponseclearXvmName in interface ISrvMonListCommandsResponseclearXvmName in interface ISrvMonXvmResponseISrvMonListCommandsResponse.setXvmName(String)public static final int getCommandsFieldId()
public final void setCommands(SrvMonCommandDescription[] val)
ISrvMonListCommandsResponsesetCommands in interface ISrvMonListCommandsResponseval - The value to set.public final void setCommandsFrom(XIterator<SrvMonCommandDescription> val)
ISrvMonListCommandsResponse
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 'commands' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[]) with
a value of null.
setCommandsFrom in interface ISrvMonListCommandsResponseval - the values to set.public final void lendCommandsFrom(XIterator<SrvMonCommandDescription> val)
ISrvMonListCommandsResponse
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 'commands' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[]) with
a value of null.
lendCommandsFrom in interface ISrvMonListCommandsResponseval - the values to set.public final void lendCommands(SrvMonCommandDescription[] val)
ISrvMonListCommandsResponse
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.
lendCommands in interface ISrvMonListCommandsResponseval - the value to 'lend' to lend.public final void addCommands(SrvMonCommandDescription val)
ISrvMonListCommandsResponseThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'commands' 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.
addCommands in interface ISrvMonListCommandsResponseval - the value to add.public final void lendCommands(SrvMonCommandDescription val)
ISrvMonListCommandsResponseLending 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 'commands' 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.
lendCommands in interface ISrvMonListCommandsResponseval - the value to add.public final SrvMonCommandDescription[] getCommands()
ISrvMonListCommandsResponse
If the field is not set this method will return null.
getCommands in interface ISrvMonListCommandsResponsenull.public final SrvMonCommandDescription[] getCommandsEmptyIfNull()
ISrvMonListCommandsResponsenull or not set.getCommandsEmptyIfNull in interface ISrvMonListCommandsResponsenull if not set.ISrvMonListCommandsResponse.getCommands()public final XIterator<SrvMonCommandDescription> getCommandsIterator()
ISrvMonListCommandsResponseThis 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
getCommandsIterator in interface ISrvMonListCommandsResponsepublic final SrvMonCommandDescription[] takeCommands()
ISrvMonListCommandsResponse
NOTE:
A nested entity reference returned by ISrvMonListCommandsResponse.getCommands() 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.
takeCommands in interface ISrvMonListCommandsResponsenull if the field is not set.public final void clearCommands()
ISrvMonListCommandsResponseclearCommands in interface ISrvMonListCommandsResponseISrvMonListCommandsResponse.setCommands(SrvMonCommandDescription[])public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
MessageViewserializeToByteArray in interface MessageViewpublic final ByteBuffer serializeToByteBuffer()
MessageViewserializeToByteBuffer in interface MessageViewpublic final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
MessageViewImplMessageView.serializeToIOBuffer(boolean)serializeToIOBuffer in interface MessageViewserializeToIOBuffer in class MessageViewImpluseNative - Whether the returned buffer should be native.public final PktPacket serializeToPacket()
MessageViewserializeToPacket in interface MessageViewpublic final SrvMonListCommandsResponse deserializeFromByteArray(byte[] array)
MessageViewdeserializeFromByteArray in interface MessageViewarray - The array containing the serialized messagepublic final SrvMonListCommandsResponse deserializeFromByteBuffer(ByteBuffer buffer)
MessageViewdeserializeFromByteBuffer in interface MessageViewbuffer - The buffer containing the serialized messagepublic final SrvMonListCommandsResponse deserializeFromPacket(PktPacket packet)
MessageViewdeserializeFromPacket in interface MessageViewpacket - The packet containing the serialized messagepublic final void sync()
MessageViewsync in interface MessageViewpublic final SrvMonListCommandsResponse 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 SrvMonListCommandsResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonListCommandsResponse 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 IRogCopyableNode<ISrvMonListCommandsResponse>copy in interface ISrvMonListCommandsResponsecopy in interface CopyableMessageView<ISrvMonListCommandsResponse>IRogCopyableNode,
CopyableMessageViewpublic final void copyInto(SrvMonListCommandsResponse copy)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonListCommandsResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonListCommandsResponse is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
copyInto in interface ISrvMonListCommandsResponsecopy - The target to copy into which must not be null or read only.public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncerdesync in interface com.neeve.xbuf.IXbufDesyncerbuffer - The buffer to desync frompos - The position in the container's backing buffer to desync
fromframeOnly - Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean) for more
informationpublic boolean needsSync()
MessageReflectorneedsSync in interface MessageReflectorpublic final boolean fieldExists(Object message, String name)
MessageReflectorfieldExists in interface MessageReflectormessage - The message to check in.name - The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflectorisFieldReflectable in interface MessageReflectormessage - The message to check in.name - The field to check for.public final String getFieldValueAsString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final String getFieldValueAsString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String name)
MessageReflector
Note that this method is generally less efficient than its variant
MessageReflector.getFieldValueAsString(Object, String[]) since this method requires
splitting the supplied path name into its dot separated path components. In cases
where the caller intends to reuse the same path name often, it is better
for the caller to supply it in split form.
getFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.name - The field whose value is to be retrieved specified as a bean pathMessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
MessageReflectorgetFieldValueAsRawString in interface MessageReflectormessage - The message to introspect.pathComponents - The path components to use to access the field.MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methodspublic final boolean appendFieldValueTo(Object message, String name, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(),
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodemessage - the node on which to reflect (which need not be this object).name - the bean path to the field on the provided object.target - The target XString into which to append the result.public final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
com.neeve.rog.impl.RogNode
If this node has a non-null messageReflector as returned by RogNode.getMessageReflector(),
then this method will use that reflector to append the value of the field provided by
it if the field is reflectable and not null.
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodenode - the node on which to reflect (which need not be this object).pathComponents - the bean path to the field on the provided object split by its '.' separated components. .target - The target XString into which to append the result.public final IStoreObject.EncodingType getContentEncodingType()
IStoreObjectgetContentEncodingType in interface IStoreObjectpublic final PktPacket serialize()
IStoreObjectserialize in interface IStoreObjectpublic final SrvMonListCommandsResponse deserialize(PktPacket packet)
IStoreObjectdeserialize in interface IStoreObjectpacket - The object in serialized form.public final IStoreObject setFieldValue(int id, Object val)
public final String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
IRogJsonizabletoJsonString in interface IRogJsonizableincludeMetadata - Specify this parameter for the ROG entity
metadata to also be included in the JSON output. If included, the
entire ROG entity object is treated as a composite object containing
a nested metadata object and a nested data object. The next two
parameters metadataObjectName and dataObjectName
specify the names of the nested objects as they will appear in
the output JSON string.metadataObjectName - The name of the nested metadata object
as it will appear in the output JSON string. A value of null will
default to using 'metadata' as the nested object name.payloadObjectName - The name of the nested data object as it
will appear in the output JSON string. A value of null will default
to using 'data' as the nested object name.public final String toJsonString()
IRogJsonizabletoJsonString in interface IRogJsonizablepublic final String toString()
com.neeve.rog.impl.RogNodetoString in class com.neeve.rog.impl.RogNodeCopyright © 2019 Neeve Research, LLC. All Rights Reserved.