@Generated(value="com.neeve.adm.AdmJsonGenerator", date="Fri Dec 05 11:53:59 EST 2025") @AdmGenerated(encoding="Json", compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 11:53 AM", buildInfo="nvx-eagle-2.9-SNAPSHOT Json Encoding") @AdmFactoryInfo(factoryClass=MessageFactory.class, vfid=132, ofid=132, typeId=8) public final class Alert extends com.neeve.rog.impl.RogNode implements IAlert, IRogJsonizable, MessageReflector
| ADM Type | Message |
| Factory | MessageFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| agentInfo | AgentInfo |
32736 | No doc provided. |
| classifier | String | 32734 | No doc provided. |
| desc | String | 32733 | No doc provided. |
| header | MessageHeader |
32737 | No doc provided. |
| headline | String | 32730 | No doc provided. |
| severity | AlertSeverity |
32731 | No doc provided. |
| stackTrace | String | 32732 | No doc provided. |
| timestamp | Date | 32735 | No doc provided. |
IRogNode.PoolingListenerIStoreObject.EncodingType| Modifier and Type | Field and Description |
|---|---|
static Alert[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
DATE_FORMAT, LAST_ROG_FID, readOnly, transactionalmessage, messageEncodingType, ownershipCount, type, vfidcount, head, next, prev| Modifier and Type | Method and Description |
|---|---|
boolean |
appendFieldValueTo(Object node,
String[] pathComponents,
XString target) |
boolean |
appendFieldValueTo(Object message,
String name,
XString target) |
void |
clearAgentInfo()
Clears the value of 'agentInfo'.
|
void |
clearClassifier()
Clears the value of 'classifier'.
|
void |
clearContent() |
void |
clearDesc()
Clears the value of 'desc'.
|
void |
clearHeader()
Clears the value of 'header'.
|
void |
clearHeadline()
Clears the value of 'headline'.
|
void |
clearSeverity()
Clears the value of 'severity'.
|
void |
clearStackTrace()
Clears the value of 'stackTrace'.
|
void |
clearTimestamp()
Clears the value of 'timestamp'.
|
Alert |
copy()
Creates a copy of this Alert.
|
void |
copyInto(Alert copy)
Copies the contents of this Alert into the target.
|
static Alert |
create() |
static Alert |
create(com.eaio.uuid.UUID id) |
static Alert |
createFrom(byte[] serializedJson) |
static Alert |
createFromJson(String json) |
static Alert |
createFromRawJson(String json) |
static Alert |
createFromSerializedJson(byte[] serializedJson) |
static Alert |
createFromSerializedJson(ByteBuffer serializedJson) |
Alert |
deserialize(PktPacket packet) |
Alert |
deserializeFromByteArray(byte[] array) |
Alert |
deserializeFromByteBuffer(ByteBuffer buffer) |
Alert |
deserializeFromJson(String json) |
Alert |
deserializeFromPacket(PktPacket packet) |
Alert |
deserializeFromProtobuf(com.google.protobuf.Message message) |
Alert |
deserializeFromRawJson(String json) |
boolean |
fieldExists(Object message,
String name) |
AgentInfo |
getAgentInfo()
Gets the value of 'agentInfo'.
|
static int |
getAgentInfoFieldId() |
void |
getAgentInfoTo(AgentInfo to)
Copies the value of AgentInfo into the provided value.
|
String |
getClassifier()
Gets the value of 'classifier'.
|
static int |
getClassifierFieldId() |
<T extends XString> |
getClassifierTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getClassifierTo(XString val)
Copies the value of 'classifier' into the provided XString.
|
XString |
getClassifierUnsafe()
Gets the raw value of 'classifier'.
|
IStoreObject.EncodingType |
getContentEncodingType() |
String |
getDesc()
Gets the value of 'desc'.
|
static int |
getDescFieldId() |
<T extends XString> |
getDescTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getDescTo(XString val)
Copies the value of 'desc' into the provided XString.
|
XString |
getDescUnsafe()
Gets the raw value of 'desc'.
|
XString |
getFieldValueAsRawString(Object message,
String name) |
XString |
getFieldValueAsRawString(Object message,
String[] pathComponents) |
String |
getFieldValueAsString(Object message,
String name) |
String |
getFieldValueAsString(Object message,
String[] pathComponents) |
MessageHeader |
getHeader()
Gets the value of 'header'.
|
static int |
getHeaderFieldId() |
void |
getHeaderTo(MessageHeader to)
Copies the value of MessageHeader into the provided value.
|
String |
getHeadline()
Gets the value of 'headline'.
|
static int |
getHeadlineFieldId() |
<T extends XString> |
getHeadlineTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getHeadlineTo(XString val)
Copies the value of 'headline' into the provided XString.
|
XString |
getHeadlineUnsafe()
Gets the raw value of 'headline'.
|
AlertSeverity |
getSeverity()
Gets the value of 'severity'.
|
static int |
getSeverityFieldId() |
String |
getStackTrace()
Gets the value of 'stackTrace'.
|
static int |
getStackTraceFieldId() |
<T extends XString> |
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'.
|
Date |
getTimestamp()
Gets the value of 'timestamp'.
|
Instant |
getTimestampAsInstant()
Retrieves the date as a java.time.Instant object.
|
long |
getTimestampAsTimestamp()
Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
|
Long |
getTimestampAsTimestampObject()
Retrieves the date as a timestamp object (autobox long).
|
static int |
getTimestampFieldId() |
boolean |
hasAgentInfo()
Checks for the presence of 'agentInfo'.
|
boolean |
hasClassifier()
Checks for the presence of 'classifier'.
|
boolean |
hasDesc()
Checks for the presence of 'desc'.
|
boolean |
hasHeader()
Checks for the presence of 'header'.
|
boolean |
hasHeadline()
Checks for the presence of 'headline'.
|
boolean |
hasSeverity()
Checks for the presence of 'severity'.
|
boolean |
hasStackTrace()
Checks for the presence of 'stackTrace'.
|
boolean |
hasTimestamp()
Checks for the presence of 'timestamp'.
|
boolean |
isFieldReflectable(Object message,
String name) |
void |
lendAgentInfo(AgentInfo val)
'Lends' a reference of the AgentInfo to the message for this field.
|
void |
lendClassifier(XString val)
Lends the value of 'classifier' to this object.
|
void |
lendDesc(XString val)
Lends the value of 'desc' to this object.
|
void |
lendHeader(MessageHeader val)
'Lends' a reference of the MessageHeader to the message for this field.
|
void |
lendHeadline(XString val)
Lends the value of 'headline' to this object.
|
void |
lendStackTrace(XString val)
Lends the value of 'stackTrace' to this object.
|
boolean |
needsSync() |
PktPacket |
serialize() |
byte[] |
serializeToByteArray() |
ByteBuffer |
serializeToByteBuffer() |
String |
serializeToJson() |
PktPacket |
serializeToPacket() |
com.google.protobuf.Message |
serializeToProtobuf() |
String |
serializeToRawJson() |
void |
setAgentInfo(AgentInfo val)
Sets the value of 'agentInfo'.
|
void |
setAsReadOnly() |
void |
setClassifier(String val)
Sets the value of 'classifier'.
|
void |
setClassifierFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setClassifierFrom(XString val)
Copies the provided XString value into this object's 'classifier'.
|
void |
setDesc(String val)
Sets the value of 'desc'.
|
void |
setDescFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setDescFrom(XString val)
Copies the provided XString value into this object's 'desc'.
|
IStoreObject |
setFieldValue(int id,
Object val) |
void |
setHeader(MessageHeader val)
Sets the value of 'header'.
|
void |
setHeadline(String val)
Sets the value of 'headline'.
|
void |
setHeadlineFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setHeadlineFrom(XString val)
Copies the provided XString value into this object's 'headline'.
|
void |
setSeverity(AlertSeverity val)
Sets the value of 'severity'.
|
void |
setStackTrace(String val)
Sets the value of 'stackTrace'.
|
void |
setStackTraceFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setStackTraceFrom(XString val)
Copies the provided XString value into this object's 'stackTrace'.
|
void |
setTimestamp(Date val)
Sets the value of 'timestamp'.
|
void |
setTimestampAsInstant(Instant val)
Sets the date value as a java.time.Instant.
|
void |
setTimestampAsTimestamp(long val)
Sets the date value as a timestamp.
|
void |
sync() |
AgentInfo |
takeAgentInfo()
'Takes' a reference to the agentInfo field from the message.
|
MessageHeader |
takeHeader()
'Takes' a reference to the header field from the message.
|
String |
toJsonString() |
String |
toJsonString(boolean includeMetadata,
String metadataObjectName,
String payloadObjectName) |
String |
toString() |
protected void |
visitFields(com.neeve.rog.impl.RogGraphVisitor visitor) |
accept, deserializeMetadata, deserializeMetadata, dispose, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCommittedDataSize, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsLiveInboundMessage, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getLastFid, 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, recordAsDirty, recordFieldUpdate, recordFieldUpdate, 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, setMessageReflector, 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, toDumpString, undispose, visitField, visitFieldacquire, copyCopyableFieldsToCopy, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, isPooled, referenceTracker, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeToIOBuffer, setMessage, setTag, undisposeclone, count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipeequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitdispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumberacquire, deserializeMetadata, deserializeMetadata, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serializeMetadata, setFieldValueensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionIdgetMessageReflectorgetEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToStringgetValidationErrors, isValidpublic static final Alert[] EMPTY_ARRAY
public static Alert create()
public static Alert create(com.eaio.uuid.UUID id)
public static Alert createFromSerializedJson(ByteBuffer serializedJson)
public static Alert createFromSerializedJson(byte[] serializedJson)
public static Alert createFrom(byte[] serializedJson)
public final void clearContent()
public final com.google.protobuf.Message serializeToProtobuf()
serializeToProtobuf in interface IRogNodepublic final String serializeToRawJson()
public final String serializeToJson()
serializeToJson in interface MessageViewpublic final Alert deserializeFromProtobuf(com.google.protobuf.Message message)
deserializeFromProtobuf in interface IRogNodepublic final Alert deserializeFromJson(String json)
deserializeFromJson in interface MessageViewpublic final void setAsReadOnly()
setAsReadOnly in interface IRogNodesetAsReadOnly in class com.neeve.rog.impl.RogNodepublic static final int getTimestampFieldId()
public final void setTimestamp(Date val)
IAlertsetTimestamp in interface IAlertval - The value to set.public final Date getTimestamp()
IAlertgetTimestamp in interface IAlertpublic final void setTimestampAsTimestamp(long val)
IAlertsetTimestampAsTimestamp in interface IAlertval - The date value in milliseconds from the epochpublic final long getTimestampAsTimestamp()
IAlert
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, IAlert.hasTimestamp()
should be called.
getTimestampAsTimestamp in interface IAlertpublic final Long getTimestampAsTimestampObject()
IAlertgetTimestampAsTimestampObject in interface IAlertpublic final void setTimestampAsInstant(Instant val)
IAlertsetTimestampAsInstant in interface IAlertval - The instant valuepublic final Instant getTimestampAsInstant()
IAlertgetTimestampAsInstant in interface IAlertpublic final void clearTimestamp()
IAlertclearTimestamp in interface IAlertIAlert.setTimestamp(Date)public final boolean hasTimestamp()
IAlerthasTimestamp in interface IAlertIAlert.getTimestamp()public static final int getSeverityFieldId()
public final void setSeverity(AlertSeverity val)
IAlertsetSeverity in interface IAlertval - The value to set.public final AlertSeverity getSeverity()
IAlertgetSeverity in interface IAlertpublic final void clearSeverity()
IAlertclearSeverity in interface IAlertIAlert.setSeverity(AlertSeverity)public final boolean hasSeverity()
IAlerthasSeverity in interface IAlertIAlert.getSeverity()public static final int getHeaderFieldId()
public final void setHeader(MessageHeader val)
IAlertpublic final void lendHeader(MessageHeader val)
IAlert
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.
lendHeader in interface IAlertval - the value to 'lend' to lend.public final MessageHeader getHeader()
IAlertpublic final void getHeaderTo(MessageHeader to)
IAlertIF the value is not set, then the contents of the provided MessageHeader are cleared.
getHeaderTo in interface IAlertto - the value to copy intoMessageHeader.copyInto(MessageHeader)public final MessageHeader takeHeader()
IAlert
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.
takeHeader in interface IAlertnull if the field is not set.public final void clearHeader()
IAlertclearHeader in interface IAlertIAlert.setHeader(MessageHeader)public final boolean hasHeader()
IAlerthasHeader in interface IAlertIAlert.getHeader()public static final int getAgentInfoFieldId()
public final void setAgentInfo(AgentInfo val)
IAlertsetAgentInfo in interface IAlertval - The value to set.public final void lendAgentInfo(AgentInfo val)
IAlert
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.
lendAgentInfo in interface IAlertval - the value to 'lend' to lend.public final AgentInfo getAgentInfo()
IAlertgetAgentInfo in interface IAlertpublic final void getAgentInfoTo(AgentInfo to)
IAlertIF the value is not set, then the contents of the provided AgentInfo are cleared.
getAgentInfoTo in interface IAlertto - the value to copy intoAgentInfo.copyInto(AgentInfo)public final AgentInfo takeAgentInfo()
IAlert
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.
takeAgentInfo in interface IAlertnull if the field is not set.public final void clearAgentInfo()
IAlertclearAgentInfo in interface IAlertIAlert.setAgentInfo(AgentInfo)public final boolean hasAgentInfo()
IAlerthasAgentInfo in interface IAlertIAlert.getAgentInfo()public static final int getClassifierFieldId()
public final void setClassifier(String val)
IAlertsetClassifier in interface IAlertval - The value to set.public final String getClassifier()
IAlertgetClassifier in interface IAlertpublic final void lendClassifier(XString val)
IAlertThis method is equivalent to setClassifier except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendClassifier in interface IAlertval - The value to set.public final void setClassifierFrom(long val)
IAlert
NOTE:
This is the same as calling IAlert.setClassifier(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setClassifierFrom in interface IAlertpublic final <T extends XString> T getClassifierTo(XString.Factory<T> factory)
IAlert
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;
getClassifierTo in interface IAlertfactory - The factory from which to get the XString to copy into and returnnull.public final void setClassifierFrom(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than IAlert.setClassifier(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setClassifierFrom in interface IAlertpublic final void getClassifierTo(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than IAlert.getClassifier() bec
because it can avoid decoding the value into an String.
getClassifierTo in interface IAlertIAlert.getClassifier()public final XString getClassifierUnsafe()
IAlert
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.
getClassifierUnsafe in interface IAlertIAlert.getClassifier()public final void clearClassifier()
IAlertclearClassifier in interface IAlertIAlert.setClassifier(String)public final boolean hasClassifier()
IAlerthasClassifier in interface IAlertIAlert.getClassifier()public static final int getDescFieldId()
public final void setDesc(String val)
IAlertpublic final String getDesc()
IAlertpublic final void lendDesc(XString val)
IAlertThis method is equivalent to setDesc except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
public final void setDescFrom(long val)
IAlert
NOTE:
This is the same as calling IAlert.setDesc(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDescFrom in interface IAlertpublic final <T extends XString> T getDescTo(XString.Factory<T> factory)
IAlert
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;
public final void setDescFrom(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than IAlert.setDesc(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDescFrom in interface IAlertpublic final void getDescTo(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than IAlert.getDesc() bec
because it can avoid decoding the value into an String.
getDescTo in interface IAlertIAlert.getDesc()public final XString getDescUnsafe()
IAlert
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.
getDescUnsafe in interface IAlertIAlert.getDesc()public final void clearDesc()
IAlertclearDesc in interface IAlertIAlert.setDesc(String)public final boolean hasDesc()
IAlerthasDesc in interface IAlertIAlert.getDesc()public static final int getStackTraceFieldId()
public final void setStackTrace(String val)
IAlertsetStackTrace in interface IAlertval - The value to set.public final String getStackTrace()
IAlertgetStackTrace in interface IAlertpublic final void lendStackTrace(XString val)
IAlertThis method is equivalent to setStackTrace except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendStackTrace in interface IAlertval - The value to set.public final void setStackTraceFrom(long val)
IAlert
NOTE:
This is the same as calling IAlert.setStackTrace(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setStackTraceFrom in interface IAlertpublic final <T extends XString> T getStackTraceTo(XString.Factory<T> factory)
IAlert
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;
getStackTraceTo in interface IAlertfactory - The factory from which to get the XString to copy into and returnnull.public final void setStackTraceFrom(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than IAlert.setStackTrace(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setStackTraceFrom in interface IAlertpublic final void getStackTraceTo(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than IAlert.getStackTrace() bec
because it can avoid decoding the value into an String.
getStackTraceTo in interface IAlertIAlert.getStackTrace()public final XString getStackTraceUnsafe()
IAlert
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.
getStackTraceUnsafe in interface IAlertIAlert.getStackTrace()public final void clearStackTrace()
IAlertclearStackTrace in interface IAlertIAlert.setStackTrace(String)public final boolean hasStackTrace()
IAlerthasStackTrace in interface IAlertIAlert.getStackTrace()public static final int getHeadlineFieldId()
public final void setHeadline(String val)
IAlertsetHeadline in interface IAlertval - The value to set.public final String getHeadline()
IAlertgetHeadline in interface IAlertpublic final void lendHeadline(XString val)
IAlertThis method is equivalent to setHeadline except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.
Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
lendHeadline in interface IAlertval - The value to set.public final void setHeadlineFrom(long val)
IAlert
NOTE:
This is the same as calling IAlert.setHeadline(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setHeadlineFrom in interface IAlertpublic final <T extends XString> T getHeadlineTo(XString.Factory<T> factory)
IAlert
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;
getHeadlineTo in interface IAlertfactory - The factory from which to get the XString to copy into and returnnull.public final void setHeadlineFrom(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than IAlert.setHeadline(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setHeadlineFrom in interface IAlertpublic final void getHeadlineTo(XString val)
IAlert
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than IAlert.getHeadline() bec
because it can avoid decoding the value into an String.
getHeadlineTo in interface IAlertIAlert.getHeadline()public final XString getHeadlineUnsafe()
IAlert
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.
getHeadlineUnsafe in interface IAlertIAlert.getHeadline()public final void clearHeadline()
IAlertclearHeadline in interface IAlertIAlert.setHeadline(String)public final boolean hasHeadline()
IAlerthasHeadline in interface IAlertIAlert.getHeadline()public final byte[] serializeToByteArray()
serializeToByteArray in interface MessageViewpublic final ByteBuffer serializeToByteBuffer()
serializeToByteBuffer in interface MessageViewpublic final PktPacket serializeToPacket()
serializeToPacket in interface MessageViewpublic final Alert deserializeFromByteArray(byte[] array)
deserializeFromByteArray in interface MessageViewpublic final Alert deserializeFromByteBuffer(ByteBuffer buffer)
deserializeFromByteBuffer in interface MessageViewpublic final Alert deserializeFromPacket(PktPacket packet)
deserializeFromPacket in interface MessageViewpublic final void sync()
sync in interface MessageViewpublic final Alert copy()
IAlertThe 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 Alert's embedded entity fields.
The returned copy will be writeable even if this Alert 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<IAlert>copy in interface IAlertcopy in interface CopyableMessageView<IAlert>IRogCopyableNode,
CopyableMessageViewpublic final void copyInto(Alert copy)
IAlertThe 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 Alert's embedded entity fields.
The returned copy will be writeable even if this Alert is read only.
No metadata is copied except as documented IRogCopyableNode.
See IRogCopyableNode for more detailed information on the semantics of this method.
public boolean needsSync()
needsSync in interface MessageReflectorpublic final boolean fieldExists(Object message, String name)
fieldExists in interface MessageReflectorpublic final boolean isFieldReflectable(Object message, String name)
isFieldReflectable in interface MessageReflectorpublic final String getFieldValueAsString(Object message, String name)
getFieldValueAsString in interface MessageReflectorpublic final String getFieldValueAsString(Object message, String[] pathComponents)
getFieldValueAsString in interface MessageReflectorpublic final XString getFieldValueAsRawString(Object message, String name)
getFieldValueAsRawString in interface MessageReflectorpublic final XString getFieldValueAsRawString(Object message, String[] pathComponents)
getFieldValueAsRawString in interface MessageReflectorpublic final boolean appendFieldValueTo(Object message, String name, XString target)
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodepublic final boolean appendFieldValueTo(Object node, String[] pathComponents, XString target)
appendFieldValueTo in interface MessageReflectorappendFieldValueTo in class com.neeve.rog.impl.RogNodepublic final IStoreObject.EncodingType getContentEncodingType()
getContentEncodingType in interface IStoreObjectpublic final PktPacket serialize()
serialize in interface IStoreObjectpublic final Alert deserialize(PktPacket packet)
deserialize in interface IStoreObjectpublic final IStoreObject setFieldValue(int id, Object val)
public final String toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName)
toJsonString in interface IRogJsonizablepublic final String toJsonString()
toJsonString in interface IRogJsonizableprotected final void visitFields(com.neeve.rog.impl.RogGraphVisitor visitor)
visitFields in class com.neeve.rog.impl.RogNodepublic final String toString()
toString in class com.neeve.rog.impl.RogNodeCopyright © 2016 Neeve Research, LLC. All Rights Reserved.