com.neeve.server.mon.lifecycle
Class SrvMonAppEngineStoppingMessage

java.lang.Object
  com.neeve.util.UtlListElement
      com.neeve.sma.MessageViewImpl
          com.neeve.rog.impl.RogNode
              com.neeve.server.mon.lifecycle.SrvMonAppEngineStoppingMessage

All Implemented Interfaces:

com.neeve.link.ILnkMessage, IStoreObject, IRogCopyableNode<ISrvMonAppEngineStoppingMessage>, IRogJsonizable, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonAppEngineStoppingMessage, CopyableMessageView<ISrvMonAppEngineStoppingMessage>, MapMessageView, MessageReflector, MessageView, UtlReferenceTracker.HasReferenceTracker, com.neeve.xbuf.IXbufDesyncer

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

Event notifying an AEP application that its engine is about to be stopped.

This event is dispatched to an application to notify it that the AEP engine is about to be stopped.

Nested Class Summary

static class

SrvMonAppEngineStoppingMessage.PacketBody The backing packet type for SrvMonAppEngineStoppingMessage (used internally for serialization purposes).

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Field Summary

static SrvMonAppEngineStoppingMessage[]

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

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

DATE_FORMAT

Fields inherited from class com.neeve.util.UtlListElement

count, head, next, prev

Method Summary

boolean	appendFieldValueTo(Object node, String[] pathComponents, XString target) Appends a reflected field value as a string into the given XString.
boolean	appendFieldValueTo(Object message, String name, XString target) Appends a reflected field value as a string into the given XString.
void	clearCause() Clears the value of 'cause' Field Description The cause of the event.
void	clearContent()
void	clearPreserveChannelJoins() Clears the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed.
void	clearTimestamp() Clears the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	clearXRogType()
SrvMonAppEngineStoppingMessage	copy() Creates a copy of this SrvMonAppEngineStoppingMessage.
void	copyInto(SrvMonAppEngineStoppingMessage copy) Copies the contents of this SrvMonAppEngineStoppingMessage into the target.
static SrvMonAppEngineStoppingMessage	create()
static SrvMonAppEngineStoppingMessage	create(com.eaio.uuid.UUID id)
static SrvMonAppEngineStoppingMessage	createFrom(byte[] serializedContainer)
static SrvMonAppEngineStoppingMessage	createFrom(ByteBuffer serializedContainer)
static SrvMonAppEngineStoppingMessage	createFromJson(String json)
static SrvMonAppEngineStoppingMessage	createFromRawJson(String json)
static SrvMonAppEngineStoppingMessage	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppEngineStoppingMessage	createFromSerializedXbufContainer(ByteBuffer serializedContainer)
static SrvMonAppEngineStoppingMessage	createFromSerializedXbufContainerPacket(byte[] serializedPacket)
static SrvMonAppEngineStoppingMessage	createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)
static SrvMonAppEngineStoppingMessage	createFromXbufContainerPacket(PktPacket packet)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppEngineStoppingMessage	deserialize(PktPacket packet) Deserialize an object's data.
SrvMonAppEngineStoppingMessage	deserializeFromByteArray(byte[] array) Deserialize a view's backing message from a byte array.
SrvMonAppEngineStoppingMessage	deserializeFromByteBuffer(ByteBuffer buffer) Deserialize a view's backing message from a byte buffer.
SrvMonAppEngineStoppingMessage	deserializeFromJson(String json) Deserialize a view's backing message from a json string
SrvMonAppEngineStoppingMessage	deserializeFromPacket(PktPacket packet) Deserialize a view's backing message from a packet.
SrvMonAppEngineStoppingMessage	deserializeFromProtobuf(com.google.protobuf.Message message) Deserialize a node's data from a protobuf message.
SrvMonAppEngineStoppingMessage	deserializeFromRawJson(String json)
int	desync(PktBuffer buffer, int pos, boolean frameOnly)
void	desyncFieldBitmask()
int	dispose() Default implementation of MessageView.dispose() This is the default implementation of the dispose method.
boolean	fieldExists(Object message, String name) Check if a field of the supplied name exists in a message.
PktBuffer	getBackingBuffer()
String	getCause() Gets the value of 'cause' Field Description The cause of the event.
com.neeve.xbuf.XbufStringField	getCauseField()
static int	getCauseFieldId() Get the field id for 'cause' This method can be used to set field interests.
<T extends XString> T	getCauseTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getCauseTo(XString val) Copies the value of 'cause' into the provided XString.
XString	getCauseUnsafe() Gets the raw value of 'cause'.
IStoreObject.EncodingType	getContentEncodingType() Get an object's content data encoding type.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
XString	getFieldValueAsRawString(Object message, String name) Get the value of a reflectable field in a message as a string.
XString	getFieldValueAsRawString(Object message, String[] pathComponents) Get the value of a reflectable field in a message as a string.
String	getFieldValueAsString(Object message, String name) Get the value of a reflectable field in a message as a string.
String	getFieldValueAsString(Object message, String[] pathComponents) Get the value of a reflectable field in a message as a string.
PktPacket	getPacket()
boolean	getPreserveChannelJoins() Gets the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed.
com.neeve.xbuf.XbufVariableBooleanField	getPreserveChannelJoinsField()
static int	getPreserveChannelJoinsFieldId() Get the field id for 'preserveChannelJoins' This method can be used to set field interests.
long	getTimestamp() Gets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
com.neeve.xbuf.XbufVariableLongField	getTimestampField()
static int	getTimestampFieldId() Get the field id for 'timestamp' This method can be used to set field interests.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId() Get the field id for 'xRogType' This method can be used to set field interests.
boolean	hasCause() Checks for the presence of 'cause' Field Description The cause of the event.
boolean	hasPreserveChannelJoins() Checks for the presence of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed.
boolean	hasTimestamp() Checks for the presence of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
boolean	hasXRogType()
boolean	isDirty()
boolean	isFieldReflectable(Object message, String name) Check if a field of the supplied name is reflectable.
void	lendCause(XString val) Sets the value of 'cause' Field Description The cause of the event.
boolean	needsSync() Check if a view needs to be sync'd for reflection.
static void	optimizeFor(int val)
PktPacket	serialize() Serialize an object's data.
byte[]	serializeToByteArray() Serialize a view's backing message to a byte array.
ByteBuffer	serializeToByteBuffer() Serialize a view's backing message to a byte buffer.
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative) Serializes the MessageView to an IOBuffer.
String	serializeToJson() Serialize a view's backing message to JSON.
PktPacket	serializeToPacket() Serialize a view's backing message to a packet.
com.google.protobuf.Message	serializeToProtobuf() Serialize a node's data to a proto message.
String	serializeToRawJson()
void	setAsReadOnly() Set whether a node is read only Note: This read-only flag only applies to data, not metadata
void	setCause(String val) Sets the value of 'cause' Field Description The cause of the event.
void	setCauseFrom(long val) Sets the value of this String field to the given numeric value.
void	setCauseFrom(com.neeve.xbuf.XbufStringField val)
void	setCauseFrom(XString val) Copies the provided XString value into this object's 'cause'.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
IStoreObject	setFieldValue(int id, Object val) Set the value of an object field.
void	setPreserveChannelJoins(boolean val) Sets the value of 'preserveChannelJoins' Field Description Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed.
void	setPreserveChannelJoinsFrom(com.neeve.xbuf.XbufVariableBooleanField val)
void	setTimestamp(long val) Sets the value of 'timestamp' Field Description The timestamp at which this event occurred (millis since the epoch).
void	setTimestampFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync() Ensure a view's backing message is prepared and ready for transport
void	syncFieldBitmask()
String	toJsonString() Get a JSON representation of an ROG entity
String	toJsonString(boolean includeMetadata, String metadataObjectName, String payloadObjectName) Get a full JSON representation of an ROG entity
String	toString() Return a string representation of this object
void	undispose(com.eaio.uuid.UUID id)

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

accept, deserializeMetadata, deserializeMetadata, dump, ensureId, getAppSendBeginTs, getAppSendDoneTs, getAttachment, getBinding, getCheckpointVersion, getCreateTs, getEnqueueTs, getEnqueueTsMicros, getFields, getGraphId, getId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsPriority, getIsReadOnly, getIsReplayedMessage, getMessageBus, getMessageBusAsRaw, getMessageChannel, getMessageChannelAsRaw, getMessageFlow, getMessageKey, getMessageKeyAsRaw, getMessageReflector, getMessageSender, getMessageSequenceNumber, getMetadata, getOfid, getOriginTs, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParent, getParentId, getPoolingListener, getPostDeserializeTs, getPostProcessingTs, getPostProcessingTsMicros, getPostSerializeTs, getPostWireSendTs, getPostWireTs, getPreDeserializeTs, getPreProcessingTs, getPreProcessingTsMicros, getPreSerializeTs, getPreWireTs, getReceiveTs, getSendStartTs, getSendTs, getSerializedMetadataLength, getStableTransactionId, getTransactionId, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, getTypeFromJson, getValidationErrors, isPossibleDuplicate, isValid, metadataToJsonString, metadataToJsonString, metadataToString, serializeMetadata, setAppSendBeginTs, setAppSendDoneTs, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setBinding, setCheckpointVersion, setCreateTs, setEnqueueTsMicros, setId, setInMsgsInTransaction, setMessageBus, setMessageBusAsRaw, setMessageChannel, setMessageChannelAsRaw, setMessageFlow, setMessageKey, setMessageKeyAsRaw, setMessageSender, setMessageSequenceNumber, setOriginTs, setOutMsgsInTransaction, setOutTs, setOutTsMicros, setParentId, setPoolingListener, setPossibleDuplicate, setPostDeserializeTs, setPostProcessingTs, setPostProcessingTsMicros, setPostSerializeTs, setPostWireSendTs, setPostWireTs, setPreDeserializeTs, setPreProcessingTs, setPreProcessingTsMicros, setPreSerializeTs, setPreWireTs, setReceiveTs, setSendStartTs, setSendTs, setStableTransactionId, setTransactionId, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from class com.neeve.sma.MessageViewImpl

acquire, getMessage, getMessageEncodingType, getOwnershipCount, getTag, getType, getVfid, referenceTracker, setTag

Methods inherited from class com.neeve.util.UtlListElement

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.neeve.rog.IRogNode

dump, getAttachment, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserializeMetadata, deserializeMetadata, ensureId, getBinding, getCheckpointVersion, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serializeMetadata, setBinding, setCheckpointVersion, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Field Detail

EMPTY_ARRAY

public static final SrvMonAppEngineStoppingMessage[] EMPTY_ARRAY

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

Method Detail

create

public static SrvMonAppEngineStoppingMessage create()

create

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

createFromXbufContainerPacket

public static SrvMonAppEngineStoppingMessage createFromXbufContainerPacket(PktPacket packet)

createFromSerializedXbufContainerPacket

public static SrvMonAppEngineStoppingMessage createFromSerializedXbufContainerPacket(ByteBuffer serializedPacket)

createFromSerializedXbufContainerPacket

public static SrvMonAppEngineStoppingMessage createFromSerializedXbufContainerPacket(byte[] serializedPacket)

createFromSerializedXbufContainer

public static SrvMonAppEngineStoppingMessage createFromSerializedXbufContainer(ByteBuffer serializedContainer)

createFromSerializedXbufContainer

public static SrvMonAppEngineStoppingMessage createFromSerializedXbufContainer(byte[] serializedContainer)

createFromRawJson

public static SrvMonAppEngineStoppingMessage createFromRawJson(String json)

createFromJson

public static SrvMonAppEngineStoppingMessage createFromJson(String json)

createFrom

public static SrvMonAppEngineStoppingMessage createFrom(ByteBuffer serializedContainer)

createFrom

public static SrvMonAppEngineStoppingMessage createFrom(byte[] serializedContainer)

setDesyncPolicy

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

getDesyncPolicy

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

setFieldInterest

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

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

getPacket

public final PktPacket getPacket()

Specified by:

getPacket in interface com.neeve.link.ILnkMessage

serializeToProtobuf

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

Description copied from interface: IRogNode

Serialize a node's data to a proto message.

Specified by:

serializeToProtobuf in interface IRogNode

serializeToRawJson

public final String serializeToRawJson()

serializeToJson

public final String serializeToJson()

Description copied from interface: MessageView

Serialize a view's backing message to JSON.

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

Specified by:

serializeToJson in interface MessageView

deserializeFromProtobuf

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

Description copied from interface: IRogNode

Deserialize a node's data from a protobuf message.

Specified by:

deserializeFromProtobuf in interface IRogNode

Parameters:

message - The protobuf message

deserializeFromRawJson

public final SrvMonAppEngineStoppingMessage deserializeFromRawJson(String json)

deserializeFromJson

public final SrvMonAppEngineStoppingMessage deserializeFromJson(String json)

Description copied from interface: MessageView

Deserialize a view's backing message from a json string

Specified by:

deserializeFromJson in interface MessageView

Parameters:

json - The view's backing message serialized as a json string.

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

setAsReadOnly

public final void setAsReadOnly()

Description copied from interface: IRogNode

Set whether a node is read only

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

Specified by:

setAsReadOnly in interface IRogNode

Overrides:

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

dispose

public int dispose()

Description copied from class: MessageViewImpl

Default implementation of MessageView.dispose()

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

Specified by:

dispose in interface IStoreObject

Specified by:

dispose in interface IRogNode

Specified by:

dispose in interface MessageView

Overrides:

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

Returns:

The reference count after the dispose completed.

undispose

public void undispose(com.eaio.uuid.UUID id)

Overrides:

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

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:

getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

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

getXRogTypeField

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

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getTimestampFieldId

public static final int getTimestampFieldId()

Get the field id for 'timestamp'

This method can be used to set field interests.

See Also:

getTimestamp()

setTimestamp

public final void setTimestamp(long val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

Sets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Specified by:

setTimestamp in interface ISrvMonAppEngineStoppingMessage

Parameters:

val - The value to set.

getTimestamp

public final long getTimestamp()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Gets the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Specified by:

getTimestamp in interface ISrvMonAppEngineStoppingMessage

Returns:

The timestamp at which this event occurred (millis since the epoch).

setTimestampFrom

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

getTimestampField

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

hasTimestamp

public final boolean hasTimestamp()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Checks for the presence of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Specified by:

hasTimestamp in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.getTimestamp()

clearTimestamp

public final void clearTimestamp()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Clears the value of 'timestamp'

Field Description

The timestamp at which this event occurred (millis since the epoch).

Specified by:

clearTimestamp in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.setTimestamp(long)

getPreserveChannelJoinsFieldId

public static final int getPreserveChannelJoinsFieldId()

Get the field id for 'preserveChannelJoins'

This method can be used to set field interests.

See Also:

getPreserveChannelJoins()

setPreserveChannelJoins

public final void setPreserveChannelJoins(boolean val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

Sets the value of 'preserveChannelJoins'

Field Description

Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.

Specified by:

setPreserveChannelJoins in interface ISrvMonAppEngineStoppingMessage

Parameters:

val - The value to set.

getPreserveChannelJoins

public final boolean getPreserveChannelJoins()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Gets the value of 'preserveChannelJoins'

Field Description

Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.

Specified by:

getPreserveChannelJoins in interface ISrvMonAppEngineStoppingMessage

Returns:

The value of 'preserveChannelJoins'

setPreserveChannelJoinsFrom

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

getPreserveChannelJoinsField

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

hasPreserveChannelJoins

public final boolean hasPreserveChannelJoins()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Checks for the presence of 'preserveChannelJoins'

Field Description

Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.

Specified by:

hasPreserveChannelJoins in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.getPreserveChannelJoins()

clearPreserveChannelJoins

public final void clearPreserveChannelJoins()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Clears the value of 'preserveChannelJoins'

Field Description

Note that a value of false for this field does not indicate that removal of channel interests and subscriptions will succeed. Nor does a value of true guarantee that all of the engines joined channels were previously established by the time the engine stopped.

Specified by:

clearPreserveChannelJoins in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.setPreserveChannelJoins(boolean)

getCauseFieldId

public static final int getCauseFieldId()

Get the field id for 'cause'

This method can be used to set field interests.

See Also:

getCause()

setCause

public final void setCause(String val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

Sets the value of 'cause'

Field Description

The cause of the event.

Specified by:

setCause in interface ISrvMonAppEngineStoppingMessage

Parameters:

val - The value to set.

getCause

public final String getCause()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Gets the value of 'cause'

Field Description

The cause of the event.

Specified by:

getCause in interface ISrvMonAppEngineStoppingMessage

Returns:

The cause of the event.

lendCause

public final void lendCause(XString val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

Sets the value of 'cause'

Field Description

The cause of the event.

Specified by:

lendCause in interface ISrvMonAppEngineStoppingMessage

Parameters:

val - The value to set.

setCauseFrom

public final void setCauseFrom(long val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

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

Field Description

The cause of the event.

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

Specified by:

setCauseFrom in interface ISrvMonAppEngineStoppingMessage

getCauseTo

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

Description copied from interface: ISrvMonAppEngineStoppingMessage

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

Field Description

The cause of the event.

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:

getCauseTo in interface ISrvMonAppEngineStoppingMessage

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.

setCauseFrom

public final void setCauseFrom(XString val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

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

Field Description

The cause of the event.

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

Specified by:

setCauseFrom in interface ISrvMonAppEngineStoppingMessage

getCauseTo

public final void getCauseTo(XString val)

Description copied from interface: ISrvMonAppEngineStoppingMessage

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

Field Description

The cause of the event.

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

Specified by:

getCauseTo in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.getCause()

getCauseUnsafe

public final XString getCauseUnsafe()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Gets the raw value of 'cause'.

Field Description

The cause of the event.

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:

getCauseUnsafe in interface ISrvMonAppEngineStoppingMessage

Returns:

the field's raw value

See Also:

ISrvMonAppEngineStoppingMessage.getCause()

setCauseFrom

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

getCauseField

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

hasCause

public final boolean hasCause()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Checks for the presence of 'cause'

Field Description

The cause of the event.

Specified by:

hasCause in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.getCause()

clearCause

public final void clearCause()

Description copied from interface: ISrvMonAppEngineStoppingMessage

Clears the value of 'cause'

Field Description

The cause of the event.

Specified by:

clearCause in interface ISrvMonAppEngineStoppingMessage

See Also:

ISrvMonAppEngineStoppingMessage.setCause(String)

isDirty

public final boolean isDirty()

createSchema

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

serializeToByteArray

public final byte[] serializeToByteArray()

Description copied from interface: MessageView

Serialize a view's backing message to a byte array.

Specified by:

serializeToByteArray in interface MessageView

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

Description copied from interface: MessageView

Serialize a view's backing message to a byte buffer.

Specified by:

serializeToByteBuffer in interface MessageView

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

Description copied from interface: MessageView

Serializes the MessageView to an IOBuffer.

Ownership of the returned IOBuffer is given to the caller which should dispose of it when done.

The buffer backing the IOBuffer should be flipped (ready for read) upon return.

Specified by:

serializeToIOBuffer in interface MessageView

Overrides:

serializeToIOBuffer in class MessageViewImpl

Parameters:

useNative - Whether the returned buffer should be native.

Returns:

The MessageView serialized to an IOBuffer.

serializeToPacket

public final PktPacket serializeToPacket()

Description copied from interface: MessageView

Serialize a view's backing message to a packet.

Specified by:

serializeToPacket in interface MessageView

deserializeFromByteArray

public final SrvMonAppEngineStoppingMessage deserializeFromByteArray(byte[] array)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte array.

Specified by:

deserializeFromByteArray in interface MessageView

Parameters:

array - The view's backing message serialized as a byte array.

deserializeFromByteBuffer

public final SrvMonAppEngineStoppingMessage deserializeFromByteBuffer(ByteBuffer buffer)

Description copied from interface: MessageView

Deserialize a view's backing message from a byte buffer.

Specified by:

deserializeFromByteBuffer in interface MessageView

Parameters:

buffer - The view's backing message serialized as a byte buffer.

deserializeFromPacket

public final SrvMonAppEngineStoppingMessage deserializeFromPacket(PktPacket packet)

Description copied from interface: MessageView

Deserialize a view's backing message from a packet.

Specified by:

deserializeFromPacket in interface MessageView

Parameters:

packet - The view's backing message serialized as a packet.

sync

public final void sync()

Description copied from interface: MessageView

Ensure a view's backing message is prepared and ready for transport

Specified by:

sync in interface MessageView

copy

public final SrvMonAppEngineStoppingMessage copy()

Creates a copy of this SrvMonAppEngineStoppingMessage.

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

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

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

Xbuf Pass-through Fields

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

Specified by:

copy in interface IRogCopyableNode<ISrvMonAppEngineStoppingMessage>

Specified by:

copy in interface ISrvMonAppEngineStoppingMessage

Specified by:

copy in interface CopyableMessageView<ISrvMonAppEngineStoppingMessage>

Returns:

A copy of this SrvMonAppEngineStoppingMessage.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

public final void copyInto(SrvMonAppEngineStoppingMessage copy)

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

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

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

Xbuf Pass-through Fields

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

Specified by:

copyInto in interface ISrvMonAppEngineStoppingMessage

Parameters:

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

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

needsSync

public boolean needsSync()

Description copied from interface: MessageReflector

Check if a view needs to be sync'd for reflection.

Specified by:

needsSync in interface MessageReflector

fieldExists

public final boolean fieldExists(Object message,
                                 String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name exists in a message.

Specified by:

fieldExists in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

isFieldReflectable

public final boolean isFieldReflectable(Object message,
                                        String name)

Description copied from interface: MessageReflector

Check if a field of the supplied name is reflectable.

Specified by:

isFieldReflectable in interface MessageReflector

Parameters:

message - The message to check in.

name - The field to check for.

Returns:

Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.

getFieldValueAsString

public final String getFieldValueAsString(Object message,
                                          String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsString

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

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

public final XString getFieldValueAsRawString(Object message,
                                              String name)

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

name - The field whose value is to be retrieved specified as a bean path

Returns:

Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

getFieldValueAsRawString

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

Description copied from interface: MessageReflector

Get the value of a reflectable field in a message as a string.

Specified by:

getFieldValueAsRawString in interface MessageReflector

Parameters:

message - The message to introspect.

pathComponents - The path components to use to access the field.

Returns:

Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods

appendFieldValueTo

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

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

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

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

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

Parameters:

message - the node on which to reflect (which need not be this object).

name - the bean path to the field.

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

appendFieldValueTo

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

Description copied from interface: MessageReflector

Appends a reflected field value as a string into the given XString.

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

Specified by:

appendFieldValueTo in interface MessageReflector

Overrides:

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

Parameters:

node - the node on which to reflect (which need not be this object).

pathComponents - the bean path to the field on the provided object split by its '.' separated components.

target - The target XString into which to append the result.

Returns:

true if the field was reflectable and had a value which could be appended, false otherwise.

getContentEncodingType

public final IStoreObject.EncodingType getContentEncodingType()

Description copied from interface: IStoreObject

Get an object's content data encoding type.

Specified by:

getContentEncodingType in interface IStoreObject

serialize

public final PktPacket serialize()

Description copied from interface: IStoreObject

Serialize an object's data.

Specified by:

serialize in interface IStoreObject

deserialize

public final SrvMonAppEngineStoppingMessage deserialize(PktPacket packet)

Description copied from interface: IStoreObject

Deserialize an object's data.

Specified by:

deserialize in interface IStoreObject

Parameters:

packet - The object in serialized form.

Returns:

Returns 'this' object for invocation chaining.

setFieldValue

public final IStoreObject setFieldValue(int id,
                                        Object val)

Description copied from interface: IStoreObject

Set the value of an object field.

Specified by:

setFieldValue in interface IStoreObject

Overrides:

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

Returns:

Returns this object for invocation chaining.

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

toJsonString

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

Description copied from interface: IRogJsonizable

Get a full JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

Parameters:

includeMetadata - Specify this parameter for the ROG entity metadata to also be included in the JSON output. If included, the entire ROG entity object is treated as a composite object containing a nested metadata object and a nested data object. The next two parameters metadataObjectName and dataObjectName specify the names of the nested objects as they will appear in the output JSON string.

metadataObjectName - The name of the nested metadata object as it will appear in the output JSON string. A value of null will default to using 'metadata' as the nested object name.

payloadObjectName - The name of the nested data object as it will appear in the output JSON string. A value of null will default to using 'data' as the nested object name.

toJsonString

public final String toJsonString()

Description copied from interface: IRogJsonizable

Get a JSON representation of an ROG entity

Specified by:

toJsonString in interface IRogJsonizable

toString

public final String toString()

Description copied from class: MessageViewImpl

Return a string representation of this object

Overrides:

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