ADM Type | Message |
Factory | SrvMonFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
appInfo | SrvMonAppInfo |
16 | Holds information about the newly created app. |
@Deprecated @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=SrvMonFactory.class, vfid=32, ofid=32, typeId=1) public final class SrvMonAppLoadedMessage extends com.neeve.rog.impl.RogNode implements ISrvMonAppLoadedMessage, com.neeve.link.ILnkMessage, MessageReflector, com.neeve.xbuf.IXbufDesyncer, IRogJsonizable
Modifier and Type | Class and Description |
---|---|
static class |
SrvMonAppLoadedMessage.PacketBody
Deprecated.
The backing packet type for SrvMonAppLoadedMessage (used internally for serialization purposes).
|
IRogNode.PoolingListener
IStoreObject.EncodingType
Modifier and Type | Field and Description |
---|---|
static SrvMonAppLoadedMessage[] |
EMPTY_ARRAY
Deprecated.
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)
Deprecated.
Appends a reflected field value as a string into the given XString.
|
boolean |
appendFieldValueTo(Object message,
String name,
XString target)
Deprecated.
Appends a reflected field value as a string into the given XString.
|
void |
clearAppInfo()
Deprecated.
Clears the value of 'appInfo'.
|
void |
clearContent()
Deprecated.
|
void |
clearXRogType()
Deprecated.
|
SrvMonAppLoadedMessage |
copy()
Deprecated.
Creates a copy of this SrvMonAppLoadedMessage.
|
void |
copyInto(SrvMonAppLoadedMessage copy)
Deprecated.
Copies the contents of this SrvMonAppLoadedMessage into the target.
|
static SrvMonAppLoadedMessage |
create()
Deprecated.
|
static SrvMonAppLoadedMessage |
create(com.eaio.uuid.UUID id)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFrom(byte[] serializedContainer)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFrom(ByteBuffer serializedContainer)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromJson(String json)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromRawJson(String json)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromSerializedXbufContainer(byte[] serializedContainer)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromSerializedXbufContainer(ByteBuffer serializedContainer)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromSerializedXbufContainerPacket(byte[] serializedPacket)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
Deprecated.
|
static SrvMonAppLoadedMessage |
createFromXbufContainerPacket(PktPacket packet)
Deprecated.
|
static com.neeve.xbuf.XbufSchema |
createSchema()
Deprecated.
|
SrvMonAppLoadedMessage |
deserialize(PktPacket packet)
Deprecated.
Deserialize an object's data.
|
SrvMonAppLoadedMessage |
deserializeFromByteArray(byte[] array)
Deprecated.
Deserialize a view's backing message from a byte array.
|
SrvMonAppLoadedMessage |
deserializeFromByteBuffer(ByteBuffer buffer)
Deprecated.
Deserialize a view's backing message from a byte buffer.
|
SrvMonAppLoadedMessage |
deserializeFromJson(String json)
Deprecated.
Deserialize a view's backing message from a json string
|
SrvMonAppLoadedMessage |
deserializeFromPacket(PktPacket packet)
Deprecated.
Deserialize a view's backing message from a packet.
|
SrvMonAppLoadedMessage |
deserializeFromProtobuf(com.google.protobuf.Message message)
Deprecated.
Deserialize a node's data from a protobuf message.
|
SrvMonAppLoadedMessage |
deserializeFromRawJson(String json)
Deprecated.
|
int |
desync(PktBuffer buffer,
int pos,
boolean frameOnly)
Deprecated.
Desync fields from a buffer
|
void |
desyncFieldBitmask()
Deprecated.
|
int |
dispose()
Deprecated.
Implementation of
IRogNode.dispose()
ROG nodes piggyback on packet pooling to perform node pooling. |
boolean |
fieldExists(Object message,
String name)
Deprecated.
Check if a field of the supplied name exists in a message.
|
SrvMonAppInfo |
getAppInfo()
Deprecated.
Gets the value of 'appInfo'.
|
static int |
getAppInfoFieldId()
Deprecated.
|
void |
getAppInfoTo(SrvMonAppInfo to)
Deprecated.
Copies the value of SrvMonAppInfo into the provided value.
|
PktBuffer |
getBackingBuffer()
Deprecated.
|
IStoreObject.EncodingType |
getContentEncodingType()
Deprecated.
Get an object's content data encoding type.
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy()
Deprecated.
|
XString |
getFieldValueAsRawString(Object message,
String name)
Deprecated.
Get the value of a reflectable field in a message as a string.
|
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents)
Deprecated.
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String name)
Deprecated.
Get the value of a reflectable field in a message as a string.
|
String |
getFieldValueAsString(Object message,
String[] pathComponents)
Deprecated.
Get the value of a reflectable field in a message as a string.
|
PktPacket |
getPacket()
Deprecated.
Return the packet tied to this message.
|
short |
getXRogType()
Deprecated.
|
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField()
Deprecated.
|
static int |
getXRogTypeFieldId()
Deprecated.
|
boolean |
hasAppInfo()
Deprecated.
Checks for the presence of 'appInfo'.
|
boolean |
hasXRogType()
Deprecated.
|
boolean |
isDirty()
Deprecated.
|
boolean |
isFieldReflectable(Object message,
String name)
Deprecated.
Check if a field of the supplied name is reflectable.
|
void |
lendAppInfo(SrvMonAppInfo val)
Deprecated.
'Lends' a reference of the SrvMonAppInfo to the message for this field.
|
boolean |
needsSync()
Deprecated.
Check if a view needs to be sync'd for reflection.
|
static void |
optimizeFor(int val)
Deprecated.
|
PktPacket |
serialize()
Deprecated.
Serialize an object's data.
|
byte[] |
serializeToByteArray()
Deprecated.
Serialize a view's backing message to a byte array.
|
ByteBuffer |
serializeToByteBuffer()
Deprecated.
Serialize a view's backing message to a byte buffer.
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
Deprecated.
Serializes the
MessageView to an IOBuffer. |
String |
serializeToJson()
Deprecated.
Serialize a view's backing message to JSON.
|
PktPacket |
serializeToPacket()
Deprecated.
Serialize a view's backing message to a packet.
|
com.google.protobuf.Message |
serializeToProtobuf()
Deprecated.
Serialize a node's data to a proto message.
|
String |
serializeToRawJson()
Deprecated.
|
void |
setAppInfo(SrvMonAppInfo val)
Deprecated.
Sets the value of 'appInfo'.
|
void |
setAsReadOnly()
Deprecated.
Implementation of
IRogNode.setAsReadOnly() |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
Deprecated.
|
static void |
setFieldInterest(List<Integer> fieldIds)
Deprecated.
|
IStoreObject |
setFieldValue(int id,
Object val)
Deprecated.
|
void |
setPreserializedFields(PktBuffer buffer)
Deprecated.
|
void |
setXRogType(short val)
Deprecated.
|
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
Deprecated.
|
void |
sync()
Deprecated.
Ensure a view's backing message is prepared and ready for transport
|
void |
syncFieldBitmask()
Deprecated.
|
SrvMonAppInfo |
takeAppInfo()
Deprecated.
'Takes' a reference to the appInfo field from the message.
|
String |
toJsonString()
Deprecated.
Get a JSON representation of an ROG entity
|
String |
toJsonString(boolean includeMetadata,
String metadataObjectName,
String payloadObjectName)
Deprecated.
Get a full JSON representation of an ROG entity
|
String |
toString()
Deprecated.
Return a string representation of an ROG node.
|
void |
undispose(com.eaio.uuid.UUID id)
Deprecated.
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
getValidationErrors, isValid
public static final SrvMonAppLoadedMessage[] EMPTY_ARRAY
public static SrvMonAppLoadedMessage create()
public static SrvMonAppLoadedMessage create(com.eaio.uuid.UUID id)
public static SrvMonAppLoadedMessage createFromXbufContainerPacket(PktPacket packet)
public static SrvMonAppLoadedMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
public static SrvMonAppLoadedMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)
public static SrvMonAppLoadedMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)
public static SrvMonAppLoadedMessage createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonAppLoadedMessage createFromRawJson(String json)
public static SrvMonAppLoadedMessage createFromJson(String json)
public static SrvMonAppLoadedMessage createFrom(ByteBuffer serializedContainer)
public static SrvMonAppLoadedMessage 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 SrvMonAppLoadedMessage deserializeFromProtobuf(com.google.protobuf.Message message)
IRogNode
deserializeFromProtobuf
in interface IRogNode
message
- The protobuf messagepublic final SrvMonAppLoadedMessage deserializeFromRawJson(String json)
public final SrvMonAppLoadedMessage 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 getAppInfoFieldId()
public final void setAppInfo(SrvMonAppInfo val)
ISrvMonAppLoadedMessage
setAppInfo
in interface ISrvMonAppLoadedMessage
val
- The value to set.public final void lendAppInfo(SrvMonAppInfo val)
ISrvMonAppLoadedMessage
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.
lendAppInfo
in interface ISrvMonAppLoadedMessage
val
- the value to 'lend' to lend.public final SrvMonAppInfo getAppInfo()
ISrvMonAppLoadedMessage
getAppInfo
in interface ISrvMonAppLoadedMessage
public final void getAppInfoTo(SrvMonAppInfo to)
ISrvMonAppLoadedMessage
IF the value is not set, then the contents of the provided SrvMonAppInfo are cleared.
getAppInfoTo
in interface ISrvMonAppLoadedMessage
to
- the value to copy intoSrvMonAppInfo.copyInto(SrvMonAppInfo)
public final SrvMonAppInfo takeAppInfo()
ISrvMonAppLoadedMessage
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.
takeAppInfo
in interface ISrvMonAppLoadedMessage
null
if the field is not set.public final boolean hasAppInfo()
ISrvMonAppLoadedMessage
hasAppInfo
in interface ISrvMonAppLoadedMessage
ISrvMonAppLoadedMessage.getAppInfo()
public final void clearAppInfo()
ISrvMonAppLoadedMessage
clearAppInfo
in interface ISrvMonAppLoadedMessage
ISrvMonAppLoadedMessage.setAppInfo(SrvMonAppInfo)
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 SrvMonAppLoadedMessage deserializeFromByteArray(byte[] array)
MessageView
deserializeFromByteArray
in interface MessageView
array
- The view's backing message serialized as a byte array.public final SrvMonAppLoadedMessage deserializeFromByteBuffer(ByteBuffer buffer)
MessageView
deserializeFromByteBuffer
in interface MessageView
buffer
- The view's backing message serialized as a byte buffer.public final SrvMonAppLoadedMessage 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 SrvMonAppLoadedMessage 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 SrvMonAppLoadedMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppLoadedMessage 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<ISrvMonAppLoadedMessage>
copy
in interface ISrvMonAppLoadedMessage
copy
in interface CopyableMessageView<ISrvMonAppLoadedMessage>
IRogCopyableNode
,
CopyableMessageView
public final void copyInto(SrvMonAppLoadedMessage 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 SrvMonAppLoadedMessage's embedded entity fields.
The returned copy will be writeable even if this SrvMonAppLoadedMessage 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 ISrvMonAppLoadedMessage
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 SrvMonAppLoadedMessage 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.