com.neeve.service.messages

Class AlertRequest

java.lang.Object

com.neeve.util.UtlListElement

com.neeve.sma.MessageViewImpl

com.neeve.rog.impl.RogNode

com.neeve.service.messages.AlertRequest

All Implemented Interfaces:

IStoreObject, IStoreObjectMetadata, IRogCopyableNode<IAlertRequest>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IAlertRequest, CopyableMessageView<IAlertRequest>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker

@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=7)
public final class AlertRequest
extends com.neeve.rog.impl.RogNode
implements IAlertRequest, IRogJsonizable, MessageReflector

The 'AlertRequest' type.

ADM Details

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.

Nested Class Summary

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

Fields

Modifier and Type	Field and Description
static AlertRequest[]	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, LAST_ROG_FID, readOnly, transactional

Fields inherited from class com.neeve.sma.MessageViewImpl

message, messageEncodingType, ownershipCount, type, vfid

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

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'.
AlertRequest	copy() Creates a copy of this AlertRequest.
void	copyInto(AlertRequest copy) Copies the contents of this AlertRequest into the target.
static AlertRequest	create()
static AlertRequest	create(com.eaio.uuid.UUID id)
static AlertRequest	createFrom(byte[] serializedJson)
static AlertRequest	createFromJson(String json)
static AlertRequest	createFromRawJson(String json)
static AlertRequest	createFromSerializedJson(byte[] serializedJson)
static AlertRequest	createFromSerializedJson(ByteBuffer serializedJson)
AlertRequest	deserialize(PktPacket packet)
AlertRequest	deserializeFromByteArray(byte[] array)
AlertRequest	deserializeFromByteBuffer(ByteBuffer buffer)
AlertRequest	deserializeFromJson(String json)
AlertRequest	deserializeFromPacket(PktPacket packet)
AlertRequest	deserializeFromProtobuf(com.google.protobuf.Message message)
AlertRequest	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> T	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> T	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> T	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> 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'.
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)

Methods inherited from class com.neeve.rog.impl.RogNode

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, visitField

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, copyCopyableFieldsToCopy, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, deserializeFrom, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, isPooled, referenceTracker, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeTo, serializeToIOBuffer, setMessage, setTag, undispose

Methods inherited from class com.neeve.util.UtlListElement

clone, count, insertAfter, insertBefore, isLinked, next, previous, unlink, wipe

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.neeve.rog.IRogNode

dispose, dump, getAttachment, getIsLiveInboundMessage, 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, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, saveMemory, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, 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, getMessageTransportHeaders, 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 AlertRequest[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Method Detail

create

public static AlertRequest create()

create

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

createFromRawJson

public static AlertRequest createFromRawJson(String json)

createFromJson

public static AlertRequest createFromJson(String json)

createFromSerializedJson

public static AlertRequest createFromSerializedJson(ByteBuffer serializedJson)

createFromSerializedJson

public static AlertRequest createFromSerializedJson(byte[] serializedJson)

createFrom

public static AlertRequest createFrom(byte[] serializedJson)

clearContent

public final void clearContent()

serializeToProtobuf

public final com.google.protobuf.Message serializeToProtobuf()

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

public final AlertRequest deserializeFromProtobuf(com.google.protobuf.Message message)

Specified by:

deserializeFromProtobuf in interface IRogNode

deserializeFromRawJson

public final AlertRequest deserializeFromRawJson(String json)

deserializeFromJson

public final AlertRequest deserializeFromJson(String json)

Specified by:

deserializeFromJson in interface MessageView

setAsReadOnly

public final void setAsReadOnly()

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

setAsReadOnly in class com.neeve.rog.impl.RogNode

getTimestampFieldId

public static final int getTimestampFieldId()

setTimestamp

public final void setTimestamp(Date val)

Description copied from interface: IAlertRequest

Sets the value of 'timestamp'.

Specified by:

setTimestamp in interface IAlertRequest

Parameters:

val - The value to set.

getTimestamp

public final Date getTimestamp()

Description copied from interface: IAlertRequest

Gets the value of 'timestamp'.

Specified by:

getTimestamp in interface IAlertRequest

Returns:

The value of 'timestamp'

setTimestampAsTimestamp

public final void setTimestampAsTimestamp(long val)

Description copied from interface: IAlertRequest

Sets the date value as a timestamp.

Specified by:

setTimestampAsTimestamp in interface IAlertRequest

Parameters:

val - The date value in milliseconds from the epoch

getTimestampAsTimestamp

public final long getTimestampAsTimestamp()

Description copied from interface: IAlertRequest

Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

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, IAlertRequest.hasTimestamp() should be called.

Specified by:

getTimestampAsTimestamp in interface IAlertRequest

Returns:

The data as a timestamp in milliseconds from the epoch or -1 if null or not set

getTimestampAsTimestampObject

public final Long getTimestampAsTimestampObject()

Description copied from interface: IAlertRequest

Retrieves the date as a timestamp object (autobox long).

Specified by:

getTimestampAsTimestampObject in interface IAlertRequest

Returns:

The data as a timestamp in milliseconds from the epoch or null if not set

setTimestampAsInstant

public final void setTimestampAsInstant(Instant val)

Description copied from interface: IAlertRequest

Sets the date value as a java.time.Instant.

Specified by:

setTimestampAsInstant in interface IAlertRequest

Parameters:

val - The instant value

getTimestampAsInstant

public final Instant getTimestampAsInstant()

Description copied from interface: IAlertRequest

Retrieves the date as a java.time.Instant object.

Specified by:

getTimestampAsInstant in interface IAlertRequest

Returns:

The data as an Instant object or null if not set

clearTimestamp

public final void clearTimestamp()

Description copied from interface: IAlertRequest

Clears the value of 'timestamp'.

Specified by:

clearTimestamp in interface IAlertRequest

See Also:

IAlertRequest.setTimestamp(Date)

hasTimestamp

public final boolean hasTimestamp()

Description copied from interface: IAlertRequest

Checks for the presence of 'timestamp'.

Specified by:

hasTimestamp in interface IAlertRequest

See Also:

IAlertRequest.getTimestamp()

getSeverityFieldId

public static final int getSeverityFieldId()

setSeverity

public final void setSeverity(AlertSeverity val)

Description copied from interface: IAlertRequest

Sets the value of 'severity'.

Specified by:

setSeverity in interface IAlertRequest

Parameters:

val - The value to set.

getSeverity

public final AlertSeverity getSeverity()

Description copied from interface: IAlertRequest

Gets the value of 'severity'.

Specified by:

getSeverity in interface IAlertRequest

Returns:

The value of 'severity'

clearSeverity

public final void clearSeverity()

Description copied from interface: IAlertRequest

Clears the value of 'severity'.

Specified by:

clearSeverity in interface IAlertRequest

See Also:

IAlertRequest.setSeverity(AlertSeverity)

hasSeverity

public final boolean hasSeverity()

Description copied from interface: IAlertRequest

Checks for the presence of 'severity'.

Specified by:

hasSeverity in interface IAlertRequest

See Also:

IAlertRequest.getSeverity()

getHeaderFieldId

public static final int getHeaderFieldId()

setHeader

public final void setHeader(MessageHeader val)

Description copied from interface: IAlertRequest

Sets the value of 'header'.

Specified by:

setHeader in interface IAlertRequest

Parameters:

val - The value to set.

lendHeader

public final void lendHeader(MessageHeader val)

Description copied from interface: IAlertRequest

'Lends' a reference of the MessageHeader to the message for this field.

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.

Specified by:

lendHeader in interface IAlertRequest

Parameters:

val - the value to 'lend' to lend.

getHeader

public final MessageHeader getHeader()

Description copied from interface: IAlertRequest

Gets the value of 'header'.

Specified by:

getHeader in interface IAlertRequest

Returns:

The value of 'header'

getHeaderTo

public final void getHeaderTo(MessageHeader to)

Description copied from interface: IAlertRequest

Copies the value of MessageHeader into the provided value.

IF the value is not set, then the contents of the provided MessageHeader are cleared.

Specified by:

getHeaderTo in interface IAlertRequest

Parameters:

to - the value to copy into

See Also:

MessageHeader.copyInto(MessageHeader)

takeHeader

public final MessageHeader takeHeader()

Description copied from interface: IAlertRequest

'Takes' a reference to the header field from the message.

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.

Specified by:

takeHeader in interface IAlertRequest

Returns:

a 'taken' reference to the field or null if the field is not set.

clearHeader

public final void clearHeader()

Description copied from interface: IAlertRequest

Clears the value of 'header'.

Specified by:

clearHeader in interface IAlertRequest

See Also:

IAlertRequest.setHeader(MessageHeader)

hasHeader

public final boolean hasHeader()

Description copied from interface: IAlertRequest

Checks for the presence of 'header'.

Specified by:

hasHeader in interface IAlertRequest

See Also:

IAlertRequest.getHeader()

getAgentInfoFieldId

public static final int getAgentInfoFieldId()

setAgentInfo

public final void setAgentInfo(AgentInfo val)

Description copied from interface: IAlertRequest

Sets the value of 'agentInfo'.

Specified by:

setAgentInfo in interface IAlertRequest

Parameters:

val - The value to set.

lendAgentInfo

public final void lendAgentInfo(AgentInfo val)

Description copied from interface: IAlertRequest

'Lends' a reference of the AgentInfo to the message for this field.

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.

Specified by:

lendAgentInfo in interface IAlertRequest

Parameters:

val - the value to 'lend' to lend.

getAgentInfo

public final AgentInfo getAgentInfo()

Description copied from interface: IAlertRequest

Gets the value of 'agentInfo'.

Specified by:

getAgentInfo in interface IAlertRequest

Returns:

The value of 'agentInfo'

getAgentInfoTo

public final void getAgentInfoTo(AgentInfo to)

Description copied from interface: IAlertRequest

Copies the value of AgentInfo into the provided value.

IF the value is not set, then the contents of the provided AgentInfo are cleared.

Specified by:

getAgentInfoTo in interface IAlertRequest

Parameters:

to - the value to copy into

See Also:

AgentInfo.copyInto(AgentInfo)

takeAgentInfo

public final AgentInfo takeAgentInfo()

Description copied from interface: IAlertRequest

'Takes' a reference to the agentInfo field from the message.

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.

Specified by:

takeAgentInfo in interface IAlertRequest

Returns:

a 'taken' reference to the field or null if the field is not set.

clearAgentInfo

public final void clearAgentInfo()

Description copied from interface: IAlertRequest

Clears the value of 'agentInfo'.

Specified by:

clearAgentInfo in interface IAlertRequest

See Also:

IAlertRequest.setAgentInfo(AgentInfo)

hasAgentInfo

public final boolean hasAgentInfo()

Description copied from interface: IAlertRequest

Checks for the presence of 'agentInfo'.

Specified by:

hasAgentInfo in interface IAlertRequest

See Also:

IAlertRequest.getAgentInfo()

getClassifierFieldId

public static final int getClassifierFieldId()

setClassifier

public final void setClassifier(String val)

Description copied from interface: IAlertRequest

Sets the value of 'classifier'.

Specified by:

setClassifier in interface IAlertRequest

Parameters:

val - The value to set.

getClassifier

public final String getClassifier()

Description copied from interface: IAlertRequest

Gets the value of 'classifier'.

Specified by:

getClassifier in interface IAlertRequest

Returns:

The value of 'classifier'

lendClassifier

public final void lendClassifier(XString val)

Description copied from interface: IAlertRequest

Lends the value of 'classifier' to this object.

This 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.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendClassifier in interface IAlertRequest

Parameters:

val - The value to set.

setClassifierFrom

public final void setClassifierFrom(long val)

Description copied from interface: IAlertRequest

Sets the value of this String field to the given numeric value.

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

Specified by:

setClassifierFrom in interface IAlertRequest

getClassifierTo

public final <T extends XString> T getClassifierTo(XString.Factory<T> factory)

Description copied from interface: IAlertRequest

Copies the value of this String field into a new XString from the given factory.

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:

getClassifierTo in interface IAlertRequest

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.

setClassifierFrom

public final void setClassifierFrom(XString val)

Description copied from interface: IAlertRequest

Copies the provided XString value into this object's 'classifier'.

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

Specified by:

setClassifierFrom in interface IAlertRequest

getClassifierTo

public final void getClassifierTo(XString val)

Description copied from interface: IAlertRequest

Copies the value of 'classifier' into the provided XString.

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

Specified by:

getClassifierTo in interface IAlertRequest

See Also:

IAlertRequest.getClassifier()

getClassifierUnsafe

public final XString getClassifierUnsafe()

Description copied from interface: IAlertRequest

Gets the raw value of 'classifier'.

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:

getClassifierUnsafe in interface IAlertRequest

Returns:

the field's raw value

See Also:

IAlertRequest.getClassifier()

clearClassifier

public final void clearClassifier()

Description copied from interface: IAlertRequest

Clears the value of 'classifier'.

Specified by:

clearClassifier in interface IAlertRequest

See Also:

IAlertRequest.setClassifier(String)

hasClassifier

public final boolean hasClassifier()

Description copied from interface: IAlertRequest

Checks for the presence of 'classifier'.

Specified by:

hasClassifier in interface IAlertRequest

See Also:

IAlertRequest.getClassifier()

getDescFieldId

public static final int getDescFieldId()

setDesc

public final void setDesc(String val)

Description copied from interface: IAlertRequest

Sets the value of 'desc'.

Specified by:

setDesc in interface IAlertRequest

Parameters:

val - The value to set.

getDesc

public final String getDesc()

Description copied from interface: IAlertRequest

Gets the value of 'desc'.

Specified by:

getDesc in interface IAlertRequest

Returns:

The value of 'desc'

lendDesc

public final void lendDesc(XString val)

Description copied from interface: IAlertRequest

Lends the value of 'desc' to this object.

This 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.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendDesc in interface IAlertRequest

Parameters:

val - The value to set.

setDescFrom

public final void setDescFrom(long val)

Description copied from interface: IAlertRequest

Sets the value of this String field to the given numeric value.

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

Specified by:

setDescFrom in interface IAlertRequest

getDescTo

public final <T extends XString> T getDescTo(XString.Factory<T> factory)

Description copied from interface: IAlertRequest

Copies the value of this String field into a new XString from the given factory.

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:

getDescTo in interface IAlertRequest

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.

setDescFrom

public final void setDescFrom(XString val)

Description copied from interface: IAlertRequest

Copies the provided XString value into this object's 'desc'.

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

Specified by:

setDescFrom in interface IAlertRequest

getDescTo

public final void getDescTo(XString val)

Description copied from interface: IAlertRequest

Copies the value of 'desc' into the provided XString.

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

Specified by:

getDescTo in interface IAlertRequest

See Also:

IAlertRequest.getDesc()

getDescUnsafe

public final XString getDescUnsafe()

Description copied from interface: IAlertRequest

Gets the raw value of 'desc'.

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:

getDescUnsafe in interface IAlertRequest

Returns:

the field's raw value

See Also:

IAlertRequest.getDesc()

clearDesc

public final void clearDesc()

Description copied from interface: IAlertRequest

Clears the value of 'desc'.

Specified by:

clearDesc in interface IAlertRequest

See Also:

IAlertRequest.setDesc(String)

hasDesc

public final boolean hasDesc()

Description copied from interface: IAlertRequest

Checks for the presence of 'desc'.

Specified by:

hasDesc in interface IAlertRequest

See Also:

IAlertRequest.getDesc()

getStackTraceFieldId

public static final int getStackTraceFieldId()

setStackTrace

public final void setStackTrace(String val)

Description copied from interface: IAlertRequest

Sets the value of 'stackTrace'.

Specified by:

setStackTrace in interface IAlertRequest

Parameters:

val - The value to set.

getStackTrace

public final String getStackTrace()

Description copied from interface: IAlertRequest

Gets the value of 'stackTrace'.

Specified by:

getStackTrace in interface IAlertRequest

Returns:

The value of 'stackTrace'

lendStackTrace

public final void lendStackTrace(XString val)

Description copied from interface: IAlertRequest

Lends the value of 'stackTrace' to this object.

This 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.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendStackTrace in interface IAlertRequest

Parameters:

val - The value to set.

setStackTraceFrom

public final void setStackTraceFrom(long val)

Description copied from interface: IAlertRequest

Sets the value of this String field to the given numeric value.

NOTE:
This is the same as calling IAlertRequest.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 IAlertRequest

getStackTraceTo

public final <T extends XString> T getStackTraceTo(XString.Factory<T> factory)

Description copied from interface: IAlertRequest

Copies the value of this String field into a new XString from the given factory.

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 IAlertRequest

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: IAlertRequest

Copies the provided XString value into this object's 'stackTrace'.

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

Specified by:

setStackTraceFrom in interface IAlertRequest

getStackTraceTo

public final void getStackTraceTo(XString val)

Description copied from interface: IAlertRequest

Copies the value of 'stackTrace' into the provided XString.

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

Specified by:

getStackTraceTo in interface IAlertRequest

See Also:

IAlertRequest.getStackTrace()

getStackTraceUnsafe

public final XString getStackTraceUnsafe()

Description copied from interface: IAlertRequest

Gets the raw value of 'stackTrace'.

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 IAlertRequest

Returns:

the field's raw value

See Also:

IAlertRequest.getStackTrace()

clearStackTrace

public final void clearStackTrace()

Description copied from interface: IAlertRequest

Clears the value of 'stackTrace'.

Specified by:

clearStackTrace in interface IAlertRequest

See Also:

IAlertRequest.setStackTrace(String)

hasStackTrace

public final boolean hasStackTrace()

Description copied from interface: IAlertRequest

Checks for the presence of 'stackTrace'.

Specified by:

hasStackTrace in interface IAlertRequest

See Also:

IAlertRequest.getStackTrace()

getHeadlineFieldId

public static final int getHeadlineFieldId()

setHeadline

public final void setHeadline(String val)

Description copied from interface: IAlertRequest

Sets the value of 'headline'.

Specified by:

setHeadline in interface IAlertRequest

Parameters:

val - The value to set.

getHeadline

public final String getHeadline()

Description copied from interface: IAlertRequest

Gets the value of 'headline'.

Specified by:

getHeadline in interface IAlertRequest

Returns:

The value of 'headline'

lendHeadline

public final void lendHeadline(XString val)

Description copied from interface: IAlertRequest

Lends the value of 'headline' to this object.

This 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.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

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.

Specified by:

lendHeadline in interface IAlertRequest

Parameters:

val - The value to set.

setHeadlineFrom

public final void setHeadlineFrom(long val)

Description copied from interface: IAlertRequest

Sets the value of this String field to the given numeric value.

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

Specified by:

setHeadlineFrom in interface IAlertRequest

getHeadlineTo

public final <T extends XString> T getHeadlineTo(XString.Factory<T> factory)

Description copied from interface: IAlertRequest

Copies the value of this String field into a new XString from the given factory.

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:

getHeadlineTo in interface IAlertRequest

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.

setHeadlineFrom

public final void setHeadlineFrom(XString val)

Description copied from interface: IAlertRequest

Copies the provided XString value into this object's 'headline'.

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

Specified by:

setHeadlineFrom in interface IAlertRequest

getHeadlineTo

public final void getHeadlineTo(XString val)

Description copied from interface: IAlertRequest

Copies the value of 'headline' into the provided XString.

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

Specified by:

getHeadlineTo in interface IAlertRequest

See Also:

IAlertRequest.getHeadline()

getHeadlineUnsafe

public final XString getHeadlineUnsafe()

Description copied from interface: IAlertRequest

Gets the raw value of 'headline'.

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:

getHeadlineUnsafe in interface IAlertRequest

Returns:

the field's raw value

See Also:

IAlertRequest.getHeadline()

clearHeadline

public final void clearHeadline()

Description copied from interface: IAlertRequest

Clears the value of 'headline'.

Specified by:

clearHeadline in interface IAlertRequest

See Also:

IAlertRequest.setHeadline(String)

hasHeadline

public final boolean hasHeadline()

Description copied from interface: IAlertRequest

Checks for the presence of 'headline'.

Specified by:

hasHeadline in interface IAlertRequest

See Also:

IAlertRequest.getHeadline()

serializeToByteArray

public final byte[] serializeToByteArray()

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Specified by:

serializeToByteBuffer in interface MessageView

serializeToPacket

public final PktPacket serializeToPacket()

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final AlertRequest deserializeFromByteArray(byte[] array)

Specified by:

deserializeFromByteArray in interface MessageView

deserializeFromByteBuffer

public final AlertRequest deserializeFromByteBuffer(ByteBuffer buffer)

Specified by:

deserializeFromByteBuffer in interface MessageView

deserializeFromPacket

public final AlertRequest deserializeFromPacket(PktPacket packet)

Specified by:

deserializeFromPacket in interface MessageView

sync

public final void sync()

Specified by:

sync in interface MessageView

copy

public final AlertRequest copy()

Description copied from interface: IAlertRequest

Creates a copy of this AlertRequest.

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

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

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

Specified by:

copy in interface IRogCopyableNode<IAlertRequest>

Specified by:

copy in interface IAlertRequest

Specified by:

copy in interface CopyableMessageView<IAlertRequest>

Returns:

A copy of this AlertRequest.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(AlertRequest copy)

Description copied from interface: IAlertRequest

Copies the contents of this AlertRequest 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 AlertRequest's embedded entity fields.

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

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

Specified by:

copyInto in interface IAlertRequest

Parameters:

copy - The target to copy into which must not be null or read only.

needsSync

public boolean needsSync()

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)

Specified by:

fieldExists in interface MessageReflector

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)

Specified by:

isFieldReflectable in interface MessageReflector

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)

Specified by:

getFieldValueAsString in interface MessageReflector

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String[] pathComponents)

Specified by:

getFieldValueAsString in interface MessageReflector

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)

Specified by:

getFieldValueAsRawString in interface MessageReflector

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String[] pathComponents)

Specified by:

getFieldValueAsRawString in interface MessageReflector

appendFieldValueTo

public final boolean appendFieldValueTo(Object message,
                                        String name,
                                        XString target)

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

appendFieldValueTo

public final boolean appendFieldValueTo(Object node,
                                        String[] pathComponents,
                                        XString target)

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

appendFieldValueTo in class com.neeve.rog.impl.RogNode

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Specified by:

serialize in interface IStoreObject

deserialize

public final AlertRequest deserialize(PktPacket packet)

Specified by:

deserialize in interface IStoreObject

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)

toJsonString

public final String toJsonString(boolean includeMetadata,
                                 String metadataObjectName,
                                 String payloadObjectName)

Specified by:

toJsonString in interface IRogJsonizable

toJsonString

public final String toJsonString()

Specified by:

toJsonString in interface IRogJsonizable

visitFields

protected final void visitFields(com.neeve.rog.impl.RogGraphVisitor visitor)

Overrides:

visitFields in class com.neeve.rog.impl.RogNode

toString

public final String toString()

Overrides:

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