@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Thu May 07 15:37:32 EDT 2020") @AdmGenerated(encoding="Xbuf", 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)") @AdmFactoryInfo(factoryClass=SrvMonCncFactory.class, vfid=36, ofid=36, typeId=9) public final class SrvMonXvmInfoResponse extends com.neeve.rog.impl.RogNode implements ISrvMonXvmInfoResponse, 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. |
correlationId | Long | 217 | The request correlation ID. |
systemName | String | 16 | The system name to which the XVM belongs. |
systemVersion | String | 17 | The version of the system to which the XVM belongs. |
xvmAdminVersion | String | 6020 | The admin protocol version of an XVM. |
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 |
SrvMonXvmInfoResponse.PacketBody
The backing packet type for SrvMonXvmInfoResponse (used internally for serialization purposes).
|
IRogNode.PoolingListener
IStoreObject.EncodingType
Modifier and Type | Field and Description |
---|---|
static SrvMonXvmInfoResponse[] |
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 |
---|---|
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 |
clearContent() |
void |
clearCorrelationId()
Clears the value of 'correlationId'.
|
void |
clearSystemName()
Clears the value of 'systemName'.
|
void |
clearSystemVersion()
Clears the value of 'systemVersion'.
|
void |
clearXRogType() |
void |
clearXvmAdminVersion()
Clears the value of 'xvmAdminVersion'.
|
void |
clearXvmHeader()
Clears the value of 'xvmHeader'.
|
void |
clearXvmName()
Clears the value of 'xvmName'.
|
SrvMonXvmInfoResponse |
copy()
Creates a copy of this SrvMonXvmInfoResponse.
|
void |
copyInto(SrvMonXvmInfoResponse copy)
Copies the contents of this SrvMonXvmInfoResponse into the target.
|
static SrvMonXvmInfoResponse |
create() |
static SrvMonXvmInfoResponse |
create(com.eaio.uuid.UUID id) |
static SrvMonXvmInfoResponse |
createFrom(byte[] serializedContainer) |
static SrvMonXvmInfoResponse |
createFrom(ByteBuffer serializedContainer) |
static SrvMonXvmInfoResponse |
createFromJson(String json) |
static SrvMonXvmInfoResponse |
createFromRawJson(String json) |
static SrvMonXvmInfoResponse |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonXvmInfoResponse |
createFromSerializedXbufContainer(ByteBuffer serializedContainer) |
static SrvMonXvmInfoResponse |
createFromSerializedXbufContainerPacket(byte[] serializedPacket) |
static SrvMonXvmInfoResponse |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket) |
static SrvMonXvmInfoResponse |
createFromXbufContainerPacket(PktPacket packet) |
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonXvmInfoResponse |
deserialize(PktPacket packet)
Deserialize an object's data.
|
SrvMonXvmInfoResponse |
deserializeFromByteArray(byte[] array)
Deserialize a view's backing message from a byte array.
|
SrvMonXvmInfoResponse |
deserializeFromByteBuffer(ByteBuffer buffer)
Deserialize a view's backing message from a byte buffer.
|
SrvMonXvmInfoResponse |
deserializeFromJson(String json)
Deserialize a view's backing message from a json string
|
SrvMonXvmInfoResponse |
deserializeFromPacket(PktPacket packet)
Deserialize a view's backing message from a packet.
|
SrvMonXvmInfoResponse |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deserialize a node's data from a protobuf message.
|
SrvMonXvmInfoResponse |
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() |
IStoreObject.EncodingType |
getContentEncodingType()
Get an object's content data encoding type.
|
long |
getCorrelationId()
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.
|
String |
getSystemName()
Gets the value of 'systemName'.
|
com.neeve.xbuf.XbufStringField |
getSystemNameField() |
static int |
getSystemNameFieldId() |
<T extends XString> |
getSystemNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getSystemNameTo(XString val)
Copies the value of 'systemName' into the provided XString.
|
XString |
getSystemNameUnsafe()
Gets the raw value of 'systemName'.
|
String |
getSystemVersion()
Gets the value of 'systemVersion'.
|
com.neeve.xbuf.XbufStringField |
getSystemVersionField() |
static int |
getSystemVersionFieldId() |
<T extends XString> |
getSystemVersionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getSystemVersionTo(XString val)
Copies the value of 'systemVersion' into the provided XString.
|
XString |
getSystemVersionUnsafe()
Gets the raw value of 'systemVersion'.
|
short |
getXRogType() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
String |
getXvmAdminVersion()
Gets the value of 'xvmAdminVersion'.
|
com.neeve.xbuf.XbufStringField |
getXvmAdminVersionField() |
static int |
getXvmAdminVersionFieldId() |
<T extends XString> |
getXvmAdminVersionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getXvmAdminVersionTo(XString val)
Copies the value of 'xvmAdminVersion' into the provided XString.
|
XString |
getXvmAdminVersionUnsafe()
Gets the raw value of 'xvmAdminVersion'.
|
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 |
hasSystemName()
Checks for the presence of 'systemName'.
|
boolean |
hasSystemVersion()
Checks for the presence of 'systemVersion'.
|
boolean |
hasXRogType() |
boolean |
hasXvmAdminVersion()
Checks for the presence of 'xvmAdminVersion'.
|
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 |
lendSystemName(XString val)
Lends the value of 'systemName' to this object.
|
void |
lendSystemVersion(XString val)
Lends the value of 'systemVersion' to this object.
|
void |
lendXvmAdminVersion(XString val)
Lends the value of 'xvmAdminVersion' to this object.
|
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)
Serializes the
MessageView to an IOBuffer. |
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 |
setCorrelationId(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 |
setSystemName(String val)
Sets the value of 'systemName'.
|
void |
setSystemNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setSystemNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setSystemNameFrom(XString val)
Copies the provided XString value into this object's 'systemName'.
|
void |
setSystemVersion(String val)
Sets the value of 'systemVersion'.
|
void |
setSystemVersionFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setSystemVersionFrom(com.neeve.xbuf.XbufStringField val) |
void |
setSystemVersionFrom(XString val)
Copies the provided XString value into this object's 'systemVersion'.
|
void |
setXRogType(short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setXvmAdminVersion(String val)
Sets the value of 'xvmAdminVersion'.
|
void |
setXvmAdminVersionFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setXvmAdminVersionFrom(com.neeve.xbuf.XbufStringField val) |
void |
setXvmAdminVersionFrom(XString val)
Copies the provided XString value into this object's 'xvmAdminVersion'.
|
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() |
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, setTransactionOutSequenceNumber
acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag
count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber
acquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serializeMetadata, setFieldValue
ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId
getMessageReflector
getEnqueueTs, 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, metadataToString
public static final SrvMonXvmInfoResponse[] EMPTY_ARRAY
public static SrvMonXvmInfoResponse create()
public static SrvMonXvmInfoResponse create(com.eaio.uuid.UUID id)
public static SrvMonXvmInfoResponse createFromXbufContainerPacket(PktPacket packet)
public static SrvMonXvmInfoResponse createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonXvmInfoResponse createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonXvmInfoResponse createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonXvmInfoResponse createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonXvmInfoResponse createFromRawJson(String json)
public static SrvMonXvmInfoResponse createFromJson(String json)
public static SrvMonXvmInfoResponse createFrom(ByteBuffer serializedContainer)
public static SrvMonXvmInfoResponse 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.ILnkMessage
getPacket
in interface com.neeve.link.ILnkMessage
public final com.google.protobuf.Message serializeToProtobuf()
IRogNode
serializeToProtobuf
in interface IRogNode
public final String serializeToRawJson()
public final String serializeToJson()
MessageView
Serializing/deserializing a message to/from JSON is an optional operation
serializeToJson
in interface MessageView
public final SrvMonXvmInfoResponse deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNode
deserializeFromProtobuf
in interface IRogNode
message
- The protobuf messagepublic final SrvMonXvmInfoResponse deserializeFromRawJson(String json)
public final SrvMonXvmInfoResponse deserializeFromJson(String json)
MessageView
deserializeFromJson
in interface MessageView
json
- The view's backing message serialized as a json string.
Serializing/deserializing a message to/from JSON is an optional operation
public final void setAsReadOnly()
com.neeve.rog.impl.RogNode
IRogNode.setAsReadOnly()
setAsReadOnly
in interface IRogNode
setAsReadOnly
in class com.neeve.rog.impl.RogNode
public int dispose()
com.neeve.rog.impl.RogNode
IRogNode.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 IStoreObject
dispose
in interface IRogNode
dispose
in interface MessageView
dispose
in class com.neeve.rog.impl.RogNode
public void undispose(com.eaio.uuid.UUID id)
com.neeve.rog.impl.RogNode
undispose
in class com.neeve.rog.impl.RogNode
id
- 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 short getXRogType()
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)
ISrvMonXvmInfoResponse
setCorrelationId
in interface ISrvMonXvmInfoResponse
setCorrelationId
in interface ISrvMonXvmResponse
val
- The value to set.public final long getCorrelationId()
ISrvMonXvmInfoResponse
getCorrelationId
in interface ISrvMonXvmInfoResponse
getCorrelationId
in interface ISrvMonXvmResponse
public final void setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getCorrelationIdField()
public final boolean hasCorrelationId()
ISrvMonXvmInfoResponse
hasCorrelationId
in interface ISrvMonXvmInfoResponse
hasCorrelationId
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getCorrelationId()
public final void clearCorrelationId()
ISrvMonXvmInfoResponse
clearCorrelationId
in interface ISrvMonXvmInfoResponse
clearCorrelationId
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.setCorrelationId(long)
public static final int getXvmHeaderFieldId()
public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonXvmInfoResponse
setXvmHeader
in interface ISrvMonXvmInfoResponse
setXvmHeader
in interface ISrvMonXvmResponse
setXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
val
- The value to set.public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
lendXvmHeader
in interface ISrvMonXvmResponse
lendXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
val
- the value to 'lend' to lend.public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()
ISrvMonXvmInfoResponse
getXvmHeader
in interface ISrvMonXvmInfoResponse
getXvmHeader
in interface ISrvMonXvmResponse
getXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
public final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)
ISrvMonXvmInfoResponse
IF the value is not set, then the contents of the provided SrvMonXvmHeader are cleared.
getXvmHeaderTo
in interface ISrvMonXvmInfoResponse
getXvmHeaderTo
in interface ISrvMonXvmResponse
getXvmHeaderTo
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
to
- the value to copy intoSrvMonXvmHeader.copyInto(SrvMonXvmHeader)
public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
takeXvmHeader
in interface ISrvMonXvmResponse
takeXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
null
if the field is not set.public final boolean hasXvmHeader()
ISrvMonXvmInfoResponse
hasXvmHeader
in interface ISrvMonXvmInfoResponse
hasXvmHeader
in interface ISrvMonXvmResponse
hasXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
ISrvMonXvmInfoResponse.getXvmHeader()
public final void clearXvmHeader()
ISrvMonXvmInfoResponse
clearXvmHeader
in interface ISrvMonXvmInfoResponse
clearXvmHeader
in interface ISrvMonXvmResponse
clearXvmHeader
in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader
ISrvMonXvmInfoResponse.setXvmHeader(SrvMonXvmHeader)
public static final int getAdminClientIdFieldId()
public final void setAdminClientId(String val)
ISrvMonXvmInfoResponse
setAdminClientId
in interface ISrvMonXvmInfoResponse
setAdminClientId
in interface ISrvMonXvmResponse
val
- The value to set.public final String getAdminClientId()
ISrvMonXvmInfoResponse
getAdminClientId
in interface ISrvMonXvmInfoResponse
getAdminClientId
in interface ISrvMonXvmResponse
public final void lendAdminClientId(XString val)
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
lendAdminClientId
in interface ISrvMonXvmResponse
val
- The value to set.public final void setAdminClientIdFrom(long val)
ISrvMonXvmInfoResponse
NOTE:
This is the same as calling ISrvMonXvmInfoResponse.setAdminClientId(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAdminClientIdFrom
in interface ISrvMonXvmInfoResponse
setAdminClientIdFrom
in interface ISrvMonXvmResponse
public final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
getAdminClientIdTo
in interface ISrvMonXvmResponse
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setAdminClientIdFrom(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonXvmInfoResponse.setAdminClientId(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setAdminClientIdFrom
in interface ISrvMonXvmInfoResponse
setAdminClientIdFrom
in interface ISrvMonXvmResponse
public final void getAdminClientIdTo(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonXvmInfoResponse.getAdminClientId()
bec
because it can avoid decoding the value into an String
.
getAdminClientIdTo
in interface ISrvMonXvmInfoResponse
getAdminClientIdTo
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getAdminClientId()
public final XString getAdminClientIdUnsafe()
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
getAdminClientIdUnsafe
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getAdminClientId()
public final void setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getAdminClientIdField()
public final boolean hasAdminClientId()
ISrvMonXvmInfoResponse
hasAdminClientId
in interface ISrvMonXvmInfoResponse
hasAdminClientId
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getAdminClientId()
public final void clearAdminClientId()
ISrvMonXvmInfoResponse
clearAdminClientId
in interface ISrvMonXvmInfoResponse
clearAdminClientId
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.setAdminClientId(String)
public static final int getXvmNameFieldId()
public final void setXvmName(String val)
ISrvMonXvmInfoResponse
setXvmName
in interface ISrvMonXvmInfoResponse
setXvmName
in interface ISrvMonXvmResponse
val
- The value to set.public final String getXvmName()
ISrvMonXvmInfoResponse
getXvmName
in interface ISrvMonXvmInfoResponse
getXvmName
in interface ISrvMonXvmResponse
public final void lendXvmName(XString val)
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
lendXvmName
in interface ISrvMonXvmResponse
val
- The value to set.public final void setXvmNameFrom(long val)
ISrvMonXvmInfoResponse
NOTE:
This is the same as calling ISrvMonXvmInfoResponse.setXvmName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setXvmNameFrom
in interface ISrvMonXvmInfoResponse
setXvmNameFrom
in interface ISrvMonXvmResponse
public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
getXvmNameTo
in interface ISrvMonXvmResponse
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setXvmNameFrom(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonXvmInfoResponse.setXvmName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setXvmNameFrom
in interface ISrvMonXvmInfoResponse
setXvmNameFrom
in interface ISrvMonXvmResponse
public final void getXvmNameTo(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonXvmInfoResponse.getXvmName()
bec
because it can avoid decoding the value into an String
.
getXvmNameTo
in interface ISrvMonXvmInfoResponse
getXvmNameTo
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getXvmName()
public final XString getXvmNameUnsafe()
ISrvMonXvmInfoResponse
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 ISrvMonXvmInfoResponse
getXvmNameUnsafe
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getXvmName()
public final void setXvmNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getXvmNameField()
public final boolean hasXvmName()
ISrvMonXvmInfoResponse
hasXvmName
in interface ISrvMonXvmInfoResponse
hasXvmName
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.getXvmName()
public final void clearXvmName()
ISrvMonXvmInfoResponse
clearXvmName
in interface ISrvMonXvmInfoResponse
clearXvmName
in interface ISrvMonXvmResponse
ISrvMonXvmInfoResponse.setXvmName(String)
public static final int getXvmAdminVersionFieldId()
public final void setXvmAdminVersion(String val)
ISrvMonXvmInfoResponse
setXvmAdminVersion
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final String getXvmAdminVersion()
ISrvMonXvmInfoResponse
getXvmAdminVersion
in interface ISrvMonXvmInfoResponse
public final void lendXvmAdminVersion(XString val)
ISrvMonXvmInfoResponse
This method is equivalent to setXvmAdminVersion 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.
lendXvmAdminVersion
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final void setXvmAdminVersionFrom(long val)
ISrvMonXvmInfoResponse
NOTE:
This is the same as calling ISrvMonXvmInfoResponse.setXvmAdminVersion(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setXvmAdminVersionFrom
in interface ISrvMonXvmInfoResponse
public final <T extends XString> T getXvmAdminVersionTo(XString.Factory<T> factory)
ISrvMonXvmInfoResponse
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;
getXvmAdminVersionTo
in interface ISrvMonXvmInfoResponse
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setXvmAdminVersionFrom(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonXvmInfoResponse.setXvmAdminVersion(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setXvmAdminVersionFrom
in interface ISrvMonXvmInfoResponse
public final void getXvmAdminVersionTo(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonXvmInfoResponse.getXvmAdminVersion()
bec
because it can avoid decoding the value into an String
.
getXvmAdminVersionTo
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getXvmAdminVersion()
public final XString getXvmAdminVersionUnsafe()
ISrvMonXvmInfoResponse
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.
getXvmAdminVersionUnsafe
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getXvmAdminVersion()
public final void setXvmAdminVersionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getXvmAdminVersionField()
public final boolean hasXvmAdminVersion()
ISrvMonXvmInfoResponse
hasXvmAdminVersion
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getXvmAdminVersion()
public final void clearXvmAdminVersion()
ISrvMonXvmInfoResponse
clearXvmAdminVersion
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.setXvmAdminVersion(String)
public static final int getSystemNameFieldId()
public final void setSystemName(String val)
ISrvMonXvmInfoResponse
setSystemName
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final String getSystemName()
ISrvMonXvmInfoResponse
getSystemName
in interface ISrvMonXvmInfoResponse
public final void lendSystemName(XString val)
ISrvMonXvmInfoResponse
This method is equivalent to setSystemName 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.
lendSystemName
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final void setSystemNameFrom(long val)
ISrvMonXvmInfoResponse
NOTE:
This is the same as calling ISrvMonXvmInfoResponse.setSystemName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setSystemNameFrom
in interface ISrvMonXvmInfoResponse
public final <T extends XString> T getSystemNameTo(XString.Factory<T> factory)
ISrvMonXvmInfoResponse
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;
getSystemNameTo
in interface ISrvMonXvmInfoResponse
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setSystemNameFrom(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonXvmInfoResponse.setSystemName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setSystemNameFrom
in interface ISrvMonXvmInfoResponse
public final void getSystemNameTo(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonXvmInfoResponse.getSystemName()
bec
because it can avoid decoding the value into an String
.
getSystemNameTo
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemName()
public final XString getSystemNameUnsafe()
ISrvMonXvmInfoResponse
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.
getSystemNameUnsafe
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemName()
public final void setSystemNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getSystemNameField()
public final boolean hasSystemName()
ISrvMonXvmInfoResponse
hasSystemName
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemName()
public final void clearSystemName()
ISrvMonXvmInfoResponse
clearSystemName
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.setSystemName(String)
public static final int getSystemVersionFieldId()
public final void setSystemVersion(String val)
ISrvMonXvmInfoResponse
setSystemVersion
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final String getSystemVersion()
ISrvMonXvmInfoResponse
getSystemVersion
in interface ISrvMonXvmInfoResponse
public final void lendSystemVersion(XString val)
ISrvMonXvmInfoResponse
This method is equivalent to setSystemVersion 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.
lendSystemVersion
in interface ISrvMonXvmInfoResponse
val
- The value to set.public final void setSystemVersionFrom(long val)
ISrvMonXvmInfoResponse
NOTE:
This is the same as calling ISrvMonXvmInfoResponse.setSystemVersion(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setSystemVersionFrom
in interface ISrvMonXvmInfoResponse
public final <T extends XString> T getSystemVersionTo(XString.Factory<T> factory)
ISrvMonXvmInfoResponse
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;
getSystemVersionTo
in interface ISrvMonXvmInfoResponse
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setSystemVersionFrom(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonXvmInfoResponse.setSystemVersion(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setSystemVersionFrom
in interface ISrvMonXvmInfoResponse
public final void getSystemVersionTo(XString val)
ISrvMonXvmInfoResponse
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonXvmInfoResponse.getSystemVersion()
bec
because it can avoid decoding the value into an String
.
getSystemVersionTo
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemVersion()
public final XString getSystemVersionUnsafe()
ISrvMonXvmInfoResponse
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.
getSystemVersionUnsafe
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemVersion()
public final void setSystemVersionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getSystemVersionField()
public final boolean hasSystemVersion()
ISrvMonXvmInfoResponse
hasSystemVersion
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.getSystemVersion()
public final void clearSystemVersion()
ISrvMonXvmInfoResponse
clearSystemVersion
in interface ISrvMonXvmInfoResponse
ISrvMonXvmInfoResponse.setSystemVersion(String)
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
MessageView
serializeToByteArray
in interface MessageView
public final ByteBuffer serializeToByteBuffer()
MessageView
serializeToByteBuffer
in interface MessageView
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
MessageView
MessageView
to an IOBuffer.
Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.
The buffer backing the IOBuffer should be flipped (ready for read) upon return.
serializeToIOBuffer
in interface MessageView
serializeToIOBuffer
in class MessageViewImpl
useNative
- Whether the returned buffer should be native.MessageView
serialized to an IOBuffer.public final PktPacket serializeToPacket()
MessageView
serializeToPacket
in interface MessageView
public final SrvMonXvmInfoResponse deserializeFromByteArray(byte[] array)
MessageView
deserializeFromByteArray
in interface MessageView
array
- The view's backing message serialized as a byte array.public final SrvMonXvmInfoResponse deserializeFromByteBuffer(ByteBuffer buffer)
MessageView
deserializeFromByteBuffer
in interface MessageView
buffer
- The view's backing message serialized as a byte buffer.public final SrvMonXvmInfoResponse deserializeFromPacket(PktPacket packet)
MessageView
deserializeFromPacket
in interface MessageView
packet
- The view's backing message serialized as a packet.public final void sync()
MessageView
sync
in interface MessageView
public final SrvMonXvmInfoResponse 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 SrvMonXvmInfoResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonXvmInfoResponse 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<ISrvMonXvmInfoResponse>
copy
in interface ISrvMonXvmInfoResponse
copy
in interface CopyableMessageView<ISrvMonXvmInfoResponse>
IRogCopyableNode
,
CopyableMessageView
public final void copyInto(SrvMonXvmInfoResponse 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 SrvMonXvmInfoResponse's embedded entity fields.
The returned copy will be writeable even if this SrvMonXvmInfoResponse 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 ISrvMonXvmInfoResponse
copy
- 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.IXbufDesyncer
desync
in interface com.neeve.xbuf.IXbufDesyncer
buffer
- 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()
MessageReflector
needsSync
in interface MessageReflector
public final boolean fieldExists(Object message, String name)
MessageReflector
fieldExists
in interface MessageReflector
message
- The message to check in.name
- The field to check for.public final boolean isFieldReflectable(Object message, String name)
MessageReflector
isFieldReflectable
in interface MessageReflector
message
- 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 MessageReflector
message
- 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)
MessageReflector
getFieldValueAsString
in interface MessageReflector
message
- 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 MessageReflector
message
- 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)
MessageReflector
getFieldValueAsRawString
in interface MessageReflector
message
- 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 MessageReflector
appendFieldValueTo
in class com.neeve.rog.impl.RogNode
message
- 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 MessageReflector
appendFieldValueTo
in class com.neeve.rog.impl.RogNode
node
- 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()
IStoreObject
getContentEncodingType
in interface IStoreObject
public final PktPacket serialize()
IStoreObject
serialize
in interface IStoreObject
public final SrvMonXvmInfoResponse deserialize(PktPacket packet)
IStoreObject
deserialize
in interface IStoreObject
packet
- The object in serialized form.public final IStoreObject setFieldValue(int id, Object val)
public final String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
IRogJsonizable
toJsonString
in interface IRogJsonizable
includeMetadata
- 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()
IRogJsonizable
toJsonString
in interface IRogJsonizable
public final String toString()
com.neeve.rog.impl.RogNode
toString
in class com.neeve.rog.impl.RogNode
Copyright © 2019 Neeve Research, LLC. All Rights Reserved.