com.neeve.server.mon.cnc
Class SrvMonInvokeCommandResponse

java.lang.Object
  extended by com.neeve.util.UtlListElement
      extended by com.neeve.sma.MessageViewImpl
          extended by com.neeve.rog.impl.RogNode
              extended by com.neeve.server.mon.cnc.SrvMonInvokeCommandResponse
All Implemented Interfaces:
com.neeve.link.ILnkMessage, IStoreObject, IRogCopyableNode<ISrvMonInvokeCommandResponse>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonInvokeCommandResponse, CopyableMessageView<ISrvMonInvokeCommandResponse>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=11)
public final class SrvMonInvokeCommandResponse
extends com.neeve.rog.impl.RogNode
implements ISrvMonInvokeCommandResponse, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable

Response to a command invocation.


Nested Class Summary
static class SrvMonInvokeCommandResponse.PacketBody
          The backing packet type for SrvMonInvokeCommandResponse (used internally for serialization purposes).
 
Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode
IRogNode.PoolingListener
 
Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject
IStoreObject.EncodingType
 
Field Summary
static SrvMonInvokeCommandResponse[] EMPTY_ARRAY
          A preallocated empty array used to avoid garbage when returning empty arrays of this type.
 
Fields inherited from class com.neeve.rog.impl.RogNode
DATE_FORMAT
 
Fields inherited from class com.neeve.util.UtlListElement
count, head, next, prev
 
Method Summary
 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 clearBooleanReturnValue()
          Clears the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
 void clearByteReturnValue()
          Clears the value of 'byteReturnValue' Field Description The value for a BYTE return type.
 void clearCharReturnValue()
          Clears the value of 'charReturnValue' Field Description The value for a CHAR return type.
 void clearContent()
           
 void clearDateReturnValue()
          Clears the value of 'dateReturnValue' Field Description The value for a DATE return type.
 void clearDoubleReturnValue()
          Clears the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
 void clearErrorMessage()
          Clears the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
 void clearFloatReturnValue()
          Clears the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
 void clearIntReturnValue()
          Clears the value of 'intReturnValue' Field Description The value for a INT return type.
 void clearLongReturnValue()
          Clears the value of 'longReturnValue' Field Description The value for a LONG return type.
 void clearReturnType()
          Clears the value of 'returnType' Field Description The response type.
 void clearShortReturnValue()
          Clears the value of 'shortReturnValue' Field Description The value for a SHORT return type.
 void clearStackTrace()
          Clears the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
 void clearStringReturnValue()
          Clears the value of 'stringReturnValue' Field Description The value for a STRING return type.
 void clearXRogType()
           
 SrvMonInvokeCommandResponse copy()
          Creates a copy of this SrvMonInvokeCommandResponse.
 void copyInto(SrvMonInvokeCommandResponse copy)
          Copies the contents of this SrvMonInvokeCommandResponse into the target.
static SrvMonInvokeCommandResponse create()
           
static SrvMonInvokeCommandResponse create(com.eaio.uuid.UUID id)
           
static SrvMonInvokeCommandResponse createFrom(byte[] serializedContainer)
           
static SrvMonInvokeCommandResponse createFrom(ByteBuffer serializedContainer)
           
static SrvMonInvokeCommandResponse createFromJson(String json)
           
static SrvMonInvokeCommandResponse createFromRawJson(String json)
           
static SrvMonInvokeCommandResponse createFromSerializedXbufContainer(byte[] serializedContainer)
           
static SrvMonInvokeCommandResponse createFromSerializedXbufContainer(ByteBuffer serializedContainer)
           
static SrvMonInvokeCommandResponse createFromSerializedXbufContainerPacket(byte[] serializedPacket)
           
static SrvMonInvokeCommandResponse createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
           
static SrvMonInvokeCommandResponse createFromXbufContainerPacket(PktPacket packet)
           
static com.neeve.xbuf.XbufSchema createSchema()
           
 SrvMonInvokeCommandResponse deserialize(PktPacket packet)
          Deserialize an object's data.
 SrvMonInvokeCommandResponse deserializeFromByteArray(byte[] array)
          Deserialize a view's backing message from a byte array.
 SrvMonInvokeCommandResponse deserializeFromByteBuffer(ByteBuffer buffer)
          Deserialize a view's backing message from a byte buffer.
 SrvMonInvokeCommandResponse deserializeFromJson(String json)
          Deserialize a view's backing message from a json string
 SrvMonInvokeCommandResponse deserializeFromPacket(PktPacket packet)
          Deserialize a view's backing message from a packet.
 SrvMonInvokeCommandResponse deserializeFromProtobuf(com.google.protobuf.Message message)
          Deserialize a node's data from a protobuf message.
 SrvMonInvokeCommandResponse deserializeFromRawJson(String json)
           
 int desync(PktBuffer buffer, int pos, boolean frameOnly)
           
 void desyncFieldBitmask()
           
 int dispose()
          Default implementation of MessageView.dispose() This is the default implementation of the dispose method.
 boolean fieldExists(Object message, String name)
          Check if a field of the supplied name exists in a message.
 PktBuffer getBackingBuffer()
           
 boolean getBooleanReturnValue()
          Gets the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
 com.neeve.xbuf.XbufVariableBooleanField getBooleanReturnValueField()
           
static int getBooleanReturnValueFieldId()
          Get the field id for 'booleanReturnValue' This method can be used to set field interests.
 byte getByteReturnValue()
          Gets the value of 'byteReturnValue' Field Description The value for a BYTE return type.
 com.neeve.xbuf.XbufVariableByteField getByteReturnValueField()
           
static int getByteReturnValueFieldId()
          Get the field id for 'byteReturnValue' This method can be used to set field interests.
 char getCharReturnValue()
          Gets the value of 'charReturnValue' Field Description The value for a CHAR return type.
 com.neeve.xbuf.XbufVariableCharField getCharReturnValueField()
           
static int getCharReturnValueFieldId()
          Get the field id for 'charReturnValue' This method can be used to set field interests.
 IStoreObject.EncodingType getContentEncodingType()
          Get an object's content data encoding type.
 Date getDateReturnValue()
          Gets the value of 'dateReturnValue' Field Description The value for a DATE return type.
 long getDateReturnValueAsTimestamp()
          Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
 com.neeve.xbuf.XbufVariableDateField getDateReturnValueField()
           
static int getDateReturnValueFieldId()
          Get the field id for 'dateReturnValue' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
           
 double getDoubleReturnValue()
          Gets the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
 com.neeve.xbuf.XbufDoubleField getDoubleReturnValueField()
           
static int getDoubleReturnValueFieldId()
          Get the field id for 'doubleReturnValue' This method can be used to set field interests.
 String getErrorMessage()
          Gets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
 com.neeve.xbuf.XbufStringField getErrorMessageField()
           
static int getErrorMessageFieldId()
          Get the field id for 'errorMessage' This method can be used to set field interests.
<T extends XString>
T
getErrorMessageTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getErrorMessageTo(XString val)
          Copies the value of 'errorMessage' into the provided XString.
 XString getErrorMessageUnsafe()
          Gets the raw value of 'errorMessage'.
 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.
 float getFloatReturnValue()
          Gets the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
 com.neeve.xbuf.XbufFloatField getFloatReturnValueField()
           
static int getFloatReturnValueFieldId()
          Get the field id for 'floatReturnValue' This method can be used to set field interests.
 int getIntReturnValue()
          Gets the value of 'intReturnValue' Field Description The value for a INT return type.
 com.neeve.xbuf.XbufVariableIntField getIntReturnValueField()
           
static int getIntReturnValueFieldId()
          Get the field id for 'intReturnValue' This method can be used to set field interests.
 long getLongReturnValue()
          Gets the value of 'longReturnValue' Field Description The value for a LONG return type.
 com.neeve.xbuf.XbufVariableLongField getLongReturnValueField()
           
static int getLongReturnValueFieldId()
          Get the field id for 'longReturnValue' This method can be used to set field interests.
 PktPacket getPacket()
           
 SrvMonReturnType getReturnType()
          Gets the value of 'returnType' Field Description The response type.
 com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> getReturnTypeField()
           
static int getReturnTypeFieldId()
          Get the field id for 'returnType' This method can be used to set field interests.
 short getShortReturnValue()
          Gets the value of 'shortReturnValue' Field Description The value for a SHORT return type.
 com.neeve.xbuf.XbufVariableShortField getShortReturnValueField()
           
static int getShortReturnValueFieldId()
          Get the field id for 'shortReturnValue' This method can be used to set field interests.
 String getStackTrace()
          Gets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
 com.neeve.xbuf.XbufStringField getStackTraceField()
           
static int getStackTraceFieldId()
          Get the field id for 'stackTrace' This method can be used to set field interests.
<T extends XString>
T
getStackTraceTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getStackTraceTo(XString val)
          Copies the value of 'stackTrace' into the provided XString.
 XString getStackTraceUnsafe()
          Gets the raw value of 'stackTrace'.
 String getStringReturnValue()
          Gets the value of 'stringReturnValue' Field Description The value for a STRING return type.
 com.neeve.xbuf.XbufStringField getStringReturnValueField()
           
static int getStringReturnValueFieldId()
          Get the field id for 'stringReturnValue' This method can be used to set field interests.
<T extends XString>
T
getStringReturnValueTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getStringReturnValueTo(XString val)
          Copies the value of 'stringReturnValue' into the provided XString.
 XString getStringReturnValueUnsafe()
          Gets the raw value of 'stringReturnValue'.
 short getXRogType()
           
 com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
           
static int getXRogTypeFieldId()
          Get the field id for 'xRogType' This method can be used to set field interests.
 boolean hasBooleanReturnValue()
          Checks for the presence of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
 boolean hasByteReturnValue()
          Checks for the presence of 'byteReturnValue' Field Description The value for a BYTE return type.
 boolean hasCharReturnValue()
          Checks for the presence of 'charReturnValue' Field Description The value for a CHAR return type.
 boolean hasDateReturnValue()
          Checks for the presence of 'dateReturnValue' Field Description The value for a DATE return type.
 boolean hasDoubleReturnValue()
          Checks for the presence of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
 boolean hasErrorMessage()
          Checks for the presence of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
 boolean hasFloatReturnValue()
          Checks for the presence of 'floatReturnValue' Field Description The value for a FLOAT return type.
 boolean hasIntReturnValue()
          Checks for the presence of 'intReturnValue' Field Description The value for a INT return type.
 boolean hasLongReturnValue()
          Checks for the presence of 'longReturnValue' Field Description The value for a LONG return type.
 boolean hasReturnType()
          Checks for the presence of 'returnType' Field Description The response type.
 boolean hasShortReturnValue()
          Checks for the presence of 'shortReturnValue' Field Description The value for a SHORT return type.
 boolean hasStackTrace()
          Checks for the presence of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
 boolean hasStringReturnValue()
          Checks for the presence of 'stringReturnValue' Field Description The value for a STRING return type.
 boolean hasXRogType()
           
 boolean isDirty()
           
 boolean isFieldReflectable(Object message, String name)
          Check if a field of the supplied name is reflectable.
 void lendErrorMessage(XString val)
          Sets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
 void lendStackTrace(XString val)
          Sets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
 void lendStringReturnValue(XString val)
          Sets the value of 'stringReturnValue' Field Description The value for a STRING return type.
 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 setAsReadOnly()
          Set whether a node is read only Note: This read-only flag only applies to data, not metadata
 void setBooleanReturnValue(boolean val)
          Sets the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
 void setBooleanReturnValueFrom(com.neeve.xbuf.XbufVariableBooleanField val)
           
 void setByteReturnValue(byte val)
          Sets the value of 'byteReturnValue' Field Description The value for a BYTE return type.
 void setByteReturnValueFrom(com.neeve.xbuf.XbufVariableByteField val)
           
 void setCharReturnValue(char val)
          Sets the value of 'charReturnValue' Field Description The value for a CHAR return type.
 void setCharReturnValueFrom(com.neeve.xbuf.XbufVariableCharField val)
           
 void setDateReturnValue(Date val)
          Sets the value of 'dateReturnValue' Field Description The value for a DATE return type.
 void setDateReturnValueAsTimestamp(long val)
          Sets the date value as a timestamp.
 void setDateReturnValueFrom(com.neeve.xbuf.XbufVariableDateField val)
           
static void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
           
 void setDoubleReturnValue(double val)
          Sets the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
 void setDoubleReturnValueFrom(com.neeve.xbuf.XbufDoubleField val)
           
 void setErrorMessage(String val)
          Sets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
 void setErrorMessageFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setErrorMessageFrom(com.neeve.xbuf.XbufStringField val)
           
 void setErrorMessageFrom(XString val)
          Copies the provided XString value into this object's 'errorMessage'.
static void setFieldInterest(List<Integer> fieldIds)
           
 IStoreObject setFieldValue(int id, Object val)
          Set the value of an object field.
 void setFloatReturnValue(float val)
          Sets the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
 void setFloatReturnValueFrom(com.neeve.xbuf.XbufFloatField val)
           
 void setIntReturnValue(int val)
          Sets the value of 'intReturnValue' Field Description The value for a INT return type.
 void setIntReturnValueFrom(com.neeve.xbuf.XbufVariableIntField val)
           
 void setLongReturnValue(long val)
          Sets the value of 'longReturnValue' Field Description The value for a LONG return type.
 void setLongReturnValueFrom(com.neeve.xbuf.XbufVariableLongField val)
           
 void setReturnType(SrvMonReturnType val)
          Sets the value of 'returnType' Field Description The response type.
 void setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val)
           
 void setShortReturnValue(short val)
          Sets the value of 'shortReturnValue' Field Description The value for a SHORT return type.
 void setShortReturnValueFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void setStackTrace(String val)
          Sets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
 void setStackTraceFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setStackTraceFrom(com.neeve.xbuf.XbufStringField val)
           
 void setStackTraceFrom(XString val)
          Copies the provided XString value into this object's 'stackTrace'.
 void setStringReturnValue(String val)
          Sets the value of 'stringReturnValue' Field Description The value for a STRING return type.
 void setStringReturnValueFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setStringReturnValueFrom(com.neeve.xbuf.XbufStringField val)
           
 void setStringReturnValueFrom(XString val)
          Copies the provided XString value into this object's 'stringReturnValue'.
 void setXRogType(short val)
           
 void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void sync()
          Ensure a view's backing message is prepared and ready for transport
 void syncFieldBitmask()
           
 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 this object
 void undispose(com.eaio.uuid.UUID id)
           
 
Methods inherited from class com.neeve.rog.impl.RogNode
accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, 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, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCreateTs, setEnqueueTsMicros, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, 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
 
Methods inherited from class com.neeve.sma.MessageViewImpl
acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag
 
Methods inherited from class com.neeve.util.UtlListElement
count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.neeve.rog.IRogNode
dump, getAttachment, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber
 
Methods inherited from interface com.neeve.ods.IStoreObject
acquire, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serializeMetadata, setBinding, setCheckpointVersion, setId, setStableTransactionId, setTransactionId
 
Methods inherited from interface com.neeve.sma.MapMessageView
getMessageReflector
 
Methods inherited from interface com.neeve.rog.IRogMetadata
getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString
 
Methods inherited from interface com.neeve.rog.IRogValidatable
getValidationErrors, isValid
 

Field Detail

EMPTY_ARRAY

public static final SrvMonInvokeCommandResponse[] EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static SrvMonInvokeCommandResponse create()

create

public static SrvMonInvokeCommandResponse create(com.eaio.uuid.UUID id)

createFromXbufContainerPacket

public static SrvMonInvokeCommandResponse createFromXbufContainerPacket(PktPacket packet)

createFromSerializedXbufContainerPacket

public static SrvMonInvokeCommandResponse createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

createFromSerializedXbufContainerPacket

public static SrvMonInvokeCommandResponse createFromSerializedXbufContainerPacket(byte[] serializedPacket)

createFromSerializedXbufContainer

public static SrvMonInvokeCommandResponse createFromSerializedXbufContainer(ByteBuffer serializedContainer)

createFromSerializedXbufContainer

public static SrvMonInvokeCommandResponse createFromSerializedXbufContainer(byte[] serializedContainer)

createFromRawJson

public static SrvMonInvokeCommandResponse createFromRawJson(String json)

createFromJson

public static SrvMonInvokeCommandResponse createFromJson(String json)

createFrom

public static SrvMonInvokeCommandResponse createFrom(ByteBuffer serializedContainer)

createFrom

public static SrvMonInvokeCommandResponse createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

getPacket

public final PktPacket getPacket()
Specified by:
getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()
Description copied from interface: IRogNode
Serialize a node's data to a proto message.

Specified by:
serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()
Description copied from interface: MessageView
Serialize a view's backing message to JSON.

Serializing/deserializing a message to/from JSON is an optional operation

Specified by:
serializeToJson in interface MessageView

deserializeFromProtobuf

public final SrvMonInvokeCommandResponse deserializeFromProtobuf(com.google.protobuf.Message message)
Description copied from interface: IRogNode
Deserialize a node's data from a protobuf message.

Specified by:
deserializeFromProtobuf in interface IRogNode
Parameters:
message - The protobuf message

deserializeFromRawJson

public final SrvMonInvokeCommandResponse deserializeFromRawJson(String json)

deserializeFromJson

public final SrvMonInvokeCommandResponse deserializeFromJson(String json)
Description copied from interface: MessageView
Deserialize a view's backing message from a json string

Specified by:
deserializeFromJson in interface MessageView
Parameters:
json - The view's backing message serialized as a json string.

Serializing/deserializing a message to/from JSON is an optional operation


setAsReadOnly

public final void setAsReadOnly()
Description copied from interface: IRogNode
Set whether a node is read only

Note: This read-only flag only applies to data, not metadata

Specified by:
setAsReadOnly in interface IRogNode
Overrides:
setAsReadOnly in class com.neeve.rog.impl.RogNode

dispose

public int dispose()
Description copied from class: MessageViewImpl
Default implementation of MessageView.dispose()

This is the default implementation of the dispose method. The implementation just decrements the ownership count. Implementations that implement view object pooling or other such functionality should override this method but invoke this method to decrement the object reference count.

Specified by:
dispose in interface IStoreObject
Specified by:
dispose in interface IRogNode
Specified by:
dispose in interface MessageView
Overrides:
dispose in class com.neeve.rog.impl.RogNode
Returns:
The reference count after the dispose completed.

undispose

public void undispose(com.eaio.uuid.UUID id)
Overrides:
undispose in class com.neeve.rog.impl.RogNode

getXRogTypeFieldId

public static final int getXRogTypeFieldId()
Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:
getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getReturnTypeFieldId

public static final int getReturnTypeFieldId()
Get the field id for 'returnType'

This method can be used to set field interests.

See Also:
getReturnType()

setReturnType

public final void setReturnType(SrvMonReturnType val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Specified by:
setReturnType in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

setReturnTypeFrom

public final void setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val)

getReturnTypeField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> getReturnTypeField()

getReturnType

public final SrvMonReturnType getReturnType()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Specified by:
getReturnType in interface ISrvMonInvokeCommandResponse
Returns:
The response type.

hasReturnType

public final boolean hasReturnType()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Specified by:
hasReturnType in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getReturnType()

clearReturnType

public final void clearReturnType()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Specified by:
clearReturnType in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setReturnType(SrvMonReturnType)

getBooleanReturnValueFieldId

public static final int getBooleanReturnValueFieldId()
Get the field id for 'booleanReturnValue'

This method can be used to set field interests.

See Also:
getBooleanReturnValue()

setBooleanReturnValue

public final void setBooleanReturnValue(boolean val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Specified by:
setBooleanReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getBooleanReturnValue

public final boolean getBooleanReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Specified by:
getBooleanReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a BOOLEAN return type.

setBooleanReturnValueFrom

public final void setBooleanReturnValueFrom(com.neeve.xbuf.XbufVariableBooleanField val)

getBooleanReturnValueField

public final com.neeve.xbuf.XbufVariableBooleanField getBooleanReturnValueField()

hasBooleanReturnValue

public final boolean hasBooleanReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Specified by:
hasBooleanReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getBooleanReturnValue()

clearBooleanReturnValue

public final void clearBooleanReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Specified by:
clearBooleanReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setBooleanReturnValue(boolean)

getByteReturnValueFieldId

public static final int getByteReturnValueFieldId()
Get the field id for 'byteReturnValue'

This method can be used to set field interests.

See Also:
getByteReturnValue()

setByteReturnValue

public final void setByteReturnValue(byte val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Specified by:
setByteReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getByteReturnValue

public final byte getByteReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Specified by:
getByteReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a BYTE return type.

setByteReturnValueFrom

public final void setByteReturnValueFrom(com.neeve.xbuf.XbufVariableByteField val)

getByteReturnValueField

public final com.neeve.xbuf.XbufVariableByteField getByteReturnValueField()

hasByteReturnValue

public final boolean hasByteReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Specified by:
hasByteReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getByteReturnValue()

clearByteReturnValue

public final void clearByteReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Specified by:
clearByteReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setByteReturnValue(byte)

getCharReturnValueFieldId

public static final int getCharReturnValueFieldId()
Get the field id for 'charReturnValue'

This method can be used to set field interests.

See Also:
getCharReturnValue()

setCharReturnValue

public final void setCharReturnValue(char val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

Specified by:
setCharReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getCharReturnValue

public final char getCharReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

Specified by:
getCharReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a CHAR return type.

setCharReturnValueFrom

public final void setCharReturnValueFrom(com.neeve.xbuf.XbufVariableCharField val)

getCharReturnValueField

public final com.neeve.xbuf.XbufVariableCharField getCharReturnValueField()

hasCharReturnValue

public final boolean hasCharReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'charReturnValue'

Field Description

The value for a CHAR return type.

Specified by:
hasCharReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getCharReturnValue()

clearCharReturnValue

public final void clearCharReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

Specified by:
clearCharReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setCharReturnValue(char)

getShortReturnValueFieldId

public static final int getShortReturnValueFieldId()
Get the field id for 'shortReturnValue'

This method can be used to set field interests.

See Also:
getShortReturnValue()

setShortReturnValue

public final void setShortReturnValue(short val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Specified by:
setShortReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getShortReturnValue

public final short getShortReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Specified by:
getShortReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a SHORT return type.

setShortReturnValueFrom

public final void setShortReturnValueFrom(com.neeve.xbuf.XbufVariableShortField val)

getShortReturnValueField

public final com.neeve.xbuf.XbufVariableShortField getShortReturnValueField()

hasShortReturnValue

public final boolean hasShortReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Specified by:
hasShortReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getShortReturnValue()

clearShortReturnValue

public final void clearShortReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Specified by:
clearShortReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setShortReturnValue(short)

getIntReturnValueFieldId

public static final int getIntReturnValueFieldId()
Get the field id for 'intReturnValue'

This method can be used to set field interests.

See Also:
getIntReturnValue()

setIntReturnValue

public final void setIntReturnValue(int val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'intReturnValue'

Field Description

The value for a INT return type.

Specified by:
setIntReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getIntReturnValue

public final int getIntReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'intReturnValue'

Field Description

The value for a INT return type.

Specified by:
getIntReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a INT return type.

setIntReturnValueFrom

public final void setIntReturnValueFrom(com.neeve.xbuf.XbufVariableIntField val)

getIntReturnValueField

public final com.neeve.xbuf.XbufVariableIntField getIntReturnValueField()

hasIntReturnValue

public final boolean hasIntReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'intReturnValue'

Field Description

The value for a INT return type.

Specified by:
hasIntReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getIntReturnValue()

clearIntReturnValue

public final void clearIntReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'intReturnValue'

Field Description

The value for a INT return type.

Specified by:
clearIntReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setIntReturnValue(int)

getLongReturnValueFieldId

public static final int getLongReturnValueFieldId()
Get the field id for 'longReturnValue'

This method can be used to set field interests.

See Also:
getLongReturnValue()

setLongReturnValue

public final void setLongReturnValue(long val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'longReturnValue'

Field Description

The value for a LONG return type.

Specified by:
setLongReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getLongReturnValue

public final long getLongReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'longReturnValue'

Field Description

The value for a LONG return type.

Specified by:
getLongReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a LONG return type.

setLongReturnValueFrom

public final void setLongReturnValueFrom(com.neeve.xbuf.XbufVariableLongField val)

getLongReturnValueField

public final com.neeve.xbuf.XbufVariableLongField getLongReturnValueField()

hasLongReturnValue

public final boolean hasLongReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'longReturnValue'

Field Description

The value for a LONG return type.

Specified by:
hasLongReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getLongReturnValue()

clearLongReturnValue

public final void clearLongReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'longReturnValue'

Field Description

The value for a LONG return type.

Specified by:
clearLongReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setLongReturnValue(long)

getFloatReturnValueFieldId

public static final int getFloatReturnValueFieldId()
Get the field id for 'floatReturnValue'

This method can be used to set field interests.

See Also:
getFloatReturnValue()

setFloatReturnValue

public final void setFloatReturnValue(float val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Specified by:
setFloatReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getFloatReturnValue

public final float getFloatReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Specified by:
getFloatReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a FLOAT return type.

setFloatReturnValueFrom

public final void setFloatReturnValueFrom(com.neeve.xbuf.XbufFloatField val)

getFloatReturnValueField

public final com.neeve.xbuf.XbufFloatField getFloatReturnValueField()

hasFloatReturnValue

public final boolean hasFloatReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Specified by:
hasFloatReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getFloatReturnValue()

clearFloatReturnValue

public final void clearFloatReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Specified by:
clearFloatReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setFloatReturnValue(float)

getDoubleReturnValueFieldId

public static final int getDoubleReturnValueFieldId()
Get the field id for 'doubleReturnValue'

This method can be used to set field interests.

See Also:
getDoubleReturnValue()

setDoubleReturnValue

public final void setDoubleReturnValue(double val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Specified by:
setDoubleReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getDoubleReturnValue

public final double getDoubleReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Specified by:
getDoubleReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a DOUBLE return type.

setDoubleReturnValueFrom

public final void setDoubleReturnValueFrom(com.neeve.xbuf.XbufDoubleField val)

getDoubleReturnValueField

public final com.neeve.xbuf.XbufDoubleField getDoubleReturnValueField()

hasDoubleReturnValue

public final boolean hasDoubleReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Specified by:
hasDoubleReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getDoubleReturnValue()

clearDoubleReturnValue

public final void clearDoubleReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Specified by:
clearDoubleReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setDoubleReturnValue(double)

getDateReturnValueFieldId

public static final int getDateReturnValueFieldId()
Get the field id for 'dateReturnValue'

This method can be used to set field interests.

See Also:
getDateReturnValue()

setDateReturnValue

public final void setDateReturnValue(Date val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

Specified by:
setDateReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getDateReturnValue

public final Date getDateReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

Specified by:
getDateReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a DATE return type.

setDateReturnValueAsTimestamp

public final void setDateReturnValueAsTimestamp(long val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the date value as a timestamp.

Field Description

The value for a DATE return type.

Specified by:
setDateReturnValueAsTimestamp in interface ISrvMonInvokeCommandResponse
Parameters:
val - The date value in milliseconds from the epoch

getDateReturnValueAsTimestamp

public final long getDateReturnValueAsTimestamp()
Description copied from interface: ISrvMonInvokeCommandResponse
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

Field Description

The value for a DATE return type.

NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch. In cases where a such an ambiguity is a practical concern, ISrvMonInvokeCommandResponse.hasDateReturnValue() should be called.

Specified by:
getDateReturnValueAsTimestamp in interface ISrvMonInvokeCommandResponse
Returns:
The data as a timestamp in milliseconds from the epoch or -1 if null or not set

setDateReturnValueFrom

public final void setDateReturnValueFrom(com.neeve.xbuf.XbufVariableDateField val)

getDateReturnValueField

public final com.neeve.xbuf.XbufVariableDateField getDateReturnValueField()

hasDateReturnValue

public final boolean hasDateReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'dateReturnValue'

Field Description

The value for a DATE return type.

Specified by:
hasDateReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getDateReturnValue()

clearDateReturnValue

public final void clearDateReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

Specified by:
clearDateReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setDateReturnValue(Date)

getStringReturnValueFieldId

public static final int getStringReturnValueFieldId()
Get the field id for 'stringReturnValue'

This method can be used to set field interests.

See Also:
getStringReturnValue()

setStringReturnValue

public final void setStringReturnValue(String val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Specified by:
setStringReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getStringReturnValue

public final String getStringReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Specified by:
getStringReturnValue in interface ISrvMonInvokeCommandResponse
Returns:
The value for a STRING return type.

lendStringReturnValue

public final void lendStringReturnValue(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Specified by:
lendStringReturnValue in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

setStringReturnValueFrom

public final void setStringReturnValueFrom(long val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of this String field to the given numeric value.

Field Description

The value for a STRING return type.

NOTE:
This is the same as calling ISrvMonInvokeCommandResponse.setStringReturnValue(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:
setStringReturnValueFrom in interface ISrvMonInvokeCommandResponse

getStringReturnValueTo

public final <T extends XString> T getStringReturnValueTo(XString.Factory<T> factory)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of this String field into a new XString from the given factory.

Field Description

The value for a STRING return type.

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;

Specified by:
getStringReturnValueTo in interface ISrvMonInvokeCommandResponse
Parameters:
factory - The factory from which to get the XString to copy into and return
Returns:
a new XString from the provided factory if this field is set or null.

setStringReturnValueFrom

public final void setStringReturnValueFrom(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the provided XString value into this object's 'stringReturnValue'.

Field Description

The value for a STRING return type.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonInvokeCommandResponse.setStringReturnValue(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:
setStringReturnValueFrom in interface ISrvMonInvokeCommandResponse

getStringReturnValueTo

public final void getStringReturnValueTo(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of 'stringReturnValue' into the provided XString.

Field Description

The value for a STRING return type.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonInvokeCommandResponse.getStringReturnValue() bec because it can avoid decoding the value into an String.

Specified by:
getStringReturnValueTo in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getStringReturnValue()

getStringReturnValueUnsafe

public final XString getStringReturnValueUnsafe()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the raw value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

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.

Specified by:
getStringReturnValueUnsafe in interface ISrvMonInvokeCommandResponse
Returns:
the field's raw value
See Also:
ISrvMonInvokeCommandResponse.getStringReturnValue()

setStringReturnValueFrom

public final void setStringReturnValueFrom(com.neeve.xbuf.XbufStringField val)

getStringReturnValueField

public final com.neeve.xbuf.XbufStringField getStringReturnValueField()

hasStringReturnValue

public final boolean hasStringReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'stringReturnValue'

Field Description

The value for a STRING return type.

Specified by:
hasStringReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getStringReturnValue()

clearStringReturnValue

public final void clearStringReturnValue()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Specified by:
clearStringReturnValue in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setStringReturnValue(String)

getErrorMessageFieldId

public static final int getErrorMessageFieldId()
Get the field id for 'errorMessage'

This method can be used to set field interests.

See Also:
getErrorMessage()

setErrorMessage

public final void setErrorMessage(String val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Specified by:
setErrorMessage in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getErrorMessage

public final String getErrorMessage()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Specified by:
getErrorMessage in interface ISrvMonInvokeCommandResponse
Returns:
If the command did not complete successfully this field holds an error message.

lendErrorMessage

public final void lendErrorMessage(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Specified by:
lendErrorMessage in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

setErrorMessageFrom

public final void setErrorMessageFrom(long val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of this String field to the given numeric value.

Field Description

If the command did not complete successfully this field holds an error message.

NOTE:
This is the same as calling ISrvMonInvokeCommandResponse.setErrorMessage(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:
setErrorMessageFrom in interface ISrvMonInvokeCommandResponse

getErrorMessageTo

public final <T extends XString> T getErrorMessageTo(XString.Factory<T> factory)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of this String field into a new XString from the given factory.

Field Description

If the command did not complete successfully this field holds an error message.

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;

Specified by:
getErrorMessageTo in interface ISrvMonInvokeCommandResponse
Parameters:
factory - The factory from which to get the XString to copy into and return
Returns:
a new XString from the provided factory if this field is set or null.

setErrorMessageFrom

public final void setErrorMessageFrom(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the provided XString value into this object's 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonInvokeCommandResponse.setErrorMessage(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:
setErrorMessageFrom in interface ISrvMonInvokeCommandResponse

getErrorMessageTo

public final void getErrorMessageTo(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of 'errorMessage' into the provided XString.

Field Description

If the command did not complete successfully this field holds an error message.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonInvokeCommandResponse.getErrorMessage() bec because it can avoid decoding the value into an String.

Specified by:
getErrorMessageTo in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getErrorMessage()

getErrorMessageUnsafe

public final XString getErrorMessageUnsafe()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the raw value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

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.

Specified by:
getErrorMessageUnsafe in interface ISrvMonInvokeCommandResponse
Returns:
the field's raw value
See Also:
ISrvMonInvokeCommandResponse.getErrorMessage()

setErrorMessageFrom

public final void setErrorMessageFrom(com.neeve.xbuf.XbufStringField val)

getErrorMessageField

public final com.neeve.xbuf.XbufStringField getErrorMessageField()

hasErrorMessage

public final boolean hasErrorMessage()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Specified by:
hasErrorMessage in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getErrorMessage()

clearErrorMessage

public final void clearErrorMessage()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Specified by:
clearErrorMessage in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setErrorMessage(String)

getStackTraceFieldId

public static final int getStackTraceFieldId()
Get the field id for 'stackTrace'

This method can be used to set field interests.

See Also:
getStackTrace()

setStackTrace

public final void setStackTrace(String val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Specified by:
setStackTrace in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

getStackTrace

public final String getStackTrace()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Specified by:
getStackTrace in interface ISrvMonInvokeCommandResponse
Returns:
A stack trace that can accompany an error message if there was an exception

lendStackTrace

public final void lendStackTrace(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Specified by:
lendStackTrace in interface ISrvMonInvokeCommandResponse
Parameters:
val - The value to set.

setStackTraceFrom

public final void setStackTraceFrom(long val)
Description copied from interface: ISrvMonInvokeCommandResponse
Sets the value of this String field to the given numeric value.

Field Description

A stack trace that can accompany an error message if there was an exception

NOTE:
This is the same as calling ISrvMonInvokeCommandResponse.setStackTrace(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:
setStackTraceFrom in interface ISrvMonInvokeCommandResponse

getStackTraceTo

public final <T extends XString> T getStackTraceTo(XString.Factory<T> factory)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of this String field into a new XString from the given factory.

Field Description

A stack trace that can accompany an error message if there was an exception

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;

Specified by:
getStackTraceTo in interface ISrvMonInvokeCommandResponse
Parameters:
factory - The factory from which to get the XString to copy into and return
Returns:
a new XString from the provided factory if this field is set or null.

setStackTraceFrom

public final void setStackTraceFrom(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the provided XString value into this object's 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonInvokeCommandResponse.setStackTrace(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:
setStackTraceFrom in interface ISrvMonInvokeCommandResponse

getStackTraceTo

public final void getStackTraceTo(XString val)
Description copied from interface: ISrvMonInvokeCommandResponse
Copies the value of 'stackTrace' into the provided XString.

Field Description

A stack trace that can accompany an error message if there was an exception

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonInvokeCommandResponse.getStackTrace() bec because it can avoid decoding the value into an String.

Specified by:
getStackTraceTo in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getStackTrace()

getStackTraceUnsafe

public final XString getStackTraceUnsafe()
Description copied from interface: ISrvMonInvokeCommandResponse
Gets the raw value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception

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.

Specified by:
getStackTraceUnsafe in interface ISrvMonInvokeCommandResponse
Returns:
the field's raw value
See Also:
ISrvMonInvokeCommandResponse.getStackTrace()

setStackTraceFrom

public final void setStackTraceFrom(com.neeve.xbuf.XbufStringField val)

getStackTraceField

public final com.neeve.xbuf.XbufStringField getStackTraceField()

hasStackTrace

public final boolean hasStackTrace()
Description copied from interface: ISrvMonInvokeCommandResponse
Checks for the presence of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Specified by:
hasStackTrace in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.getStackTrace()

clearStackTrace

public final void clearStackTrace()
Description copied from interface: ISrvMonInvokeCommandResponse
Clears the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Specified by:
clearStackTrace in interface ISrvMonInvokeCommandResponse
See Also:
ISrvMonInvokeCommandResponse.setStackTrace(String)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()
Description copied from interface: MessageView
Serialize a view's backing message to a byte array.

Specified by:
serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()
Description copied from interface: MessageView
Serialize a view's backing message to a byte buffer.

Specified by:
serializeToByteBuffer in interface MessageView

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
Description copied from interface: MessageView
Serializes the 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.

Specified by:
serializeToIOBuffer in interface MessageView
Overrides:
serializeToIOBuffer in class MessageViewImpl
Parameters:
useNative - Whether the returned buffer should be native.
Returns:
The MessageView serialized to an IOBuffer.

serializeToPacket

public final PktPacket serializeToPacket()
Description copied from interface: MessageView
Serialize a view's backing message to a packet.

Specified by:
serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonInvokeCommandResponse deserializeFromByteArray(byte[] array)
Description copied from interface: MessageView
Deserialize a view's backing message from a byte array.

Specified by:
deserializeFromByteArray in interface MessageView
Parameters:
array - The view's backing message serialized as a byte array.

deserializeFromByteBuffer

public final SrvMonInvokeCommandResponse deserializeFromByteBuffer(ByteBuffer buffer)
Description copied from interface: MessageView
Deserialize a view's backing message from a byte buffer.

Specified by:
deserializeFromByteBuffer in interface MessageView
Parameters:
buffer - The view's backing message serialized as a byte buffer.

deserializeFromPacket

public final SrvMonInvokeCommandResponse deserializeFromPacket(PktPacket packet)
Description copied from interface: MessageView
Deserialize a view's backing message from a packet.

Specified by:
deserializeFromPacket in interface MessageView
Parameters:
packet - The view's backing message serialized as a packet.

sync

public final void sync()
Description copied from interface: MessageView
Ensure a view's backing message is prepared and ready for transport

Specified by:
sync in interface MessageView

copy

public final SrvMonInvokeCommandResponse copy()
Creates a copy of this SrvMonInvokeCommandResponse.

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 SrvMonInvokeCommandResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonInvokeCommandResponse is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:
copy in interface IRogCopyableNode<ISrvMonInvokeCommandResponse>
Specified by:
copy in interface ISrvMonInvokeCommandResponse
Specified by:
copy in interface CopyableMessageView<ISrvMonInvokeCommandResponse>
Returns:
A copy of this SrvMonInvokeCommandResponse.
See Also:
IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonInvokeCommandResponse copy)
Copies the contents of this SrvMonInvokeCommandResponse into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonInvokeCommandResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonInvokeCommandResponse is read only.

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Specified by:
copyInto in interface ISrvMonInvokeCommandResponse
Parameters:
copy - The target to copy into which must not be null or read only.

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)
Specified by:
desync in interface com.neeve.xbuf.IXbufDesyncer

needsSync

public boolean needsSync()
Description copied from interface: MessageReflector
Check if a view needs to be sync'd for reflection.

Specified by:
needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)
Description copied from interface: MessageReflector
Check if a field of the supplied name exists in a message.

Specified by:
fieldExists in interface MessageReflector
Parameters:
message - The message to check in.
name - The field to check for.

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)
Description copied from interface: MessageReflector
Check if a field of the supplied name is reflectable.

Specified by:
isFieldReflectable in interface MessageReflector
Parameters:
message - The message to check in.
name - The field to check for.
Returns:
Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)
Description copied from interface: MessageReflector
Get the value of a reflectable field in a message as a string.

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.

Specified by:
getFieldValueAsString in interface MessageReflector
Parameters:
message - The message to introspect.
name - The field whose value is to be retrieved specified as a bean path
Returns:
Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String[] pathComponents)
Description copied from interface: MessageReflector
Get the value of a reflectable field in a message as a string.

Specified by:
getFieldValueAsString in interface MessageReflector
Parameters:
message - The message to introspect.
pathComponents - The path components to use to access the field.
Returns:
Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)
Description copied from interface: MessageReflector
Get the value of a reflectable field in a message as a string.

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.

Specified by:
getFieldValueAsRawString in interface MessageReflector
Parameters:
message - The message to introspect.
name - The field whose value is to be retrieved specified as a bean path
Returns:
Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String[] pathComponents)
Description copied from interface: MessageReflector
Get the value of a reflectable field in a message as a string.

Specified by:
getFieldValueAsRawString in interface MessageReflector
Parameters:
message - The message to introspect.
pathComponents - The path components to use to access the field.
Returns:
Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

appendFieldValueTo

public final boolean appendFieldValueTo(Object message,
                                        String name,
                                        XString target)
Description copied from interface: MessageReflector
Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:
appendFieldValueTo in interface MessageReflector
Overrides:
appendFieldValueTo in class com.neeve.rog.impl.RogNode
Parameters:
message - the node on which to reflect (which need not be this object).
name - the bean path to the field.
target - The target XString into which to append the result.
Returns:
true if the field was reflectable and had a value which could be appended, false otherwise.

appendFieldValueTo

public final boolean appendFieldValueTo(Object node,
                                        String[] pathComponents,
                                        XString target)
Description copied from interface: MessageReflector
Appends a reflected field value as a string into the given XString.

If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.

Specified by:
appendFieldValueTo in interface MessageReflector
Overrides:
appendFieldValueTo in class com.neeve.rog.impl.RogNode
Parameters:
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.
Returns:
true if the field was reflectable and had a value which could be appended, false otherwise.

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()
Description copied from interface: IStoreObject
Get an object's content data encoding type.

Specified by:
getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()
Description copied from interface: IStoreObject
Serialize an object's data.

Specified by:
serialize in interface IStoreObject

deserialize

public final SrvMonInvokeCommandResponse deserialize(PktPacket packet)
Description copied from interface: IStoreObject
Deserialize an object's data.

Specified by:
deserialize in interface IStoreObject
Parameters:
packet - The object in serialized form.
Returns:
Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)
Description copied from interface: IStoreObject
Set the value of an object field.

Specified by:
setFieldValue in interface IStoreObject
Overrides:
setFieldValue in class com.neeve.rog.impl.RogNode
Returns:
Returns this object for invocation chaining.

This method is invoked during the rollback process to restore field values.


toJsonString

public final String toJsonString(boolean includeMetadata,
                                 String metadataObjectName,
                                 String payloadObjectName)
Description copied from interface: IRogJsonizable
Get a full JSON representation of an ROG entity

Specified by:
toJsonString in interface IRogJsonizable
Parameters:
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.

toJsonString

public final String toJsonString()
Description copied from interface: IRogJsonizable
Get a JSON representation of an ROG entity

Specified by:
toJsonString in interface IRogJsonizable

toString

public final String toString()
Description copied from class: MessageViewImpl
Return a string representation of this object

Overrides:
toString in class com.neeve.rog.impl.RogNode


Copyright © 2016 Neeve Research, LLC. All Rights Reserved.