com.neeve.server.mon.alert
Class TriggeringMessageMetadata

java.lang.Object
  extended by com.neeve.server.mon.alert.TriggeringMessageMetadata
All Implemented Interfaces:
IRogValidatable, ITriggeringMessageMetadata, UtlPool.Item<TriggeringMessageMetadata>, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonAlertFactory.class,
                vfid=35,
                ofid=35,
                typeId=1000)
public final class TriggeringMessageMetadata
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<TriggeringMessageMetadata>, ITriggeringMessageMetadata

Message metadata associated with the message that caused an alert.


Nested Class Summary
static class TriggeringMessageMetadata.Field
          The TriggeringMessageMetadata xbuf field (used internally when this entity is used as a field of another entity).
static class TriggeringMessageMetadata.ListField
          The TriggeringMessageMetadata list field (used internally when this entity is used as an array field of another entity).
 
Field Summary
static TriggeringMessageMetadata[] EMPTY_ARRAY
          A preallocated empty array used to avoid garbage when returning empty arrays of this type.
 
Constructor Summary
TriggeringMessageMetadata()
           
TriggeringMessageMetadata(int initialBackingBufferSize)
           
 
Method Summary
 TriggeringMessageMetadata acquire()
           
 void clearContent()
           
 void clearTriggeringMessageMessageBusName()
          Clears the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 void clearTriggeringMessageMessageChannelId()
          Clears the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 void clearTriggeringMessageMessageChannelName()
          Clears the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 void clearTriggeringMessageMessageEncodingType()
          Clears the value of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 void clearTriggeringMessageMessageFactoryId()
          Clears the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 void clearTriggeringMessageMessageFlowId()
          Clears the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 void clearTriggeringMessageMessageKey()
          Clears the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 void clearTriggeringMessageMessageSenderId()
          Clears the value of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 void clearTriggeringMessageMessageSno()
          Clears the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 void clearTriggeringMessageMessageViewId()
          Clears the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 void clearXRogType()
           
 Object clone()
          Creates a clone of this object.
 TriggeringMessageMetadata copy()
          Creates a copy of this TriggeringMessageMetadata.
 void copyInto(TriggeringMessageMetadata copy)
          Copies the contents of this TriggeringMessageMetadata into the target.
static TriggeringMessageMetadata create()
           
static TriggeringMessageMetadata createFrom(byte[] serializedContainer)
           
static TriggeringMessageMetadata createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
static TriggeringMessageMetadata createFromSerializedXbufContainer(byte[] serializedContainer)
           
static TriggeringMessageMetadata createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
static com.neeve.xbuf.XbufSchema createSchema()
           
 TriggeringMessageMetadata deserializeFromByteArray(byte[] array)
           
 TriggeringMessageMetadata deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 TriggeringMessageMetadata deserializeFromByteBuffer(ByteBuffer buffer)
           
 TriggeringMessageMetadata deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 TriggeringMessageMetadata deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
           
 TriggeringMessageMetadata deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 TriggeringMessageMetadata deserializeFromNative(long address, int offset, int length)
           
 TriggeringMessageMetadata deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 int desync(PktBuffer buffer, int pos, boolean frameOnly)
           
 void desyncFieldBitmask()
           
 void dispose()
           
 PktBuffer getBackingBuffer()
           
static com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
           
 boolean getIsReadOnly()
           
 int getOwnerCount()
           
 UtlPool<TriggeringMessageMetadata> getPool()
          Get a pool item's pool.
 int getSerializeToNativeLength()
           
 String getTriggeringMessageMessageBusName()
          Gets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 com.neeve.xbuf.XbufStringField getTriggeringMessageMessageBusNameField()
           
static int getTriggeringMessageMessageBusNameFieldId()
          Get the field id for 'triggeringMessageMessageBusName' This method can be used to set field interests.
<T extends XString>
T
getTriggeringMessageMessageBusNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getTriggeringMessageMessageBusNameTo(XString val)
          Copies the value of 'triggeringMessageMessageBusName' into the provided XString.
 XString getTriggeringMessageMessageBusNameUnsafe()
          Gets the raw value of 'triggeringMessageMessageBusName'.
 String getTriggeringMessageMessageChannelId()
          Gets the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 com.neeve.xbuf.XbufStringField getTriggeringMessageMessageChannelIdField()
           
static int getTriggeringMessageMessageChannelIdFieldId()
          Get the field id for 'triggeringMessageMessageChannelId' This method can be used to set field interests.
<T extends XString>
T
getTriggeringMessageMessageChannelIdTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getTriggeringMessageMessageChannelIdTo(XString val)
          Copies the value of 'triggeringMessageMessageChannelId' into the provided XString.
 XString getTriggeringMessageMessageChannelIdUnsafe()
          Gets the raw value of 'triggeringMessageMessageChannelId'.
 String getTriggeringMessageMessageChannelName()
          Gets the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 com.neeve.xbuf.XbufStringField getTriggeringMessageMessageChannelNameField()
           
static int getTriggeringMessageMessageChannelNameFieldId()
          Get the field id for 'triggeringMessageMessageChannelName' This method can be used to set field interests.
<T extends XString>
T
getTriggeringMessageMessageChannelNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getTriggeringMessageMessageChannelNameTo(XString val)
          Copies the value of 'triggeringMessageMessageChannelName' into the provided XString.
 XString getTriggeringMessageMessageChannelNameUnsafe()
          Gets the raw value of 'triggeringMessageMessageChannelName'.
 byte getTriggeringMessageMessageEncodingType()
          Gets the value of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableByteField getTriggeringMessageMessageEncodingTypeField()
           
static int getTriggeringMessageMessageEncodingTypeFieldId()
          Get the field id for 'triggeringMessageMessageEncodingType' This method can be used to set field interests.
 short getTriggeringMessageMessageFactoryId()
          Gets the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableShortField getTriggeringMessageMessageFactoryIdField()
           
static int getTriggeringMessageMessageFactoryIdFieldId()
          Get the field id for 'triggeringMessageMessageFactoryId' This method can be used to set field interests.
 int getTriggeringMessageMessageFlowId()
          Gets the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableIntField getTriggeringMessageMessageFlowIdField()
           
static int getTriggeringMessageMessageFlowIdFieldId()
          Get the field id for 'triggeringMessageMessageFlowId' This method can be used to set field interests.
 String getTriggeringMessageMessageKey()
          Gets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 com.neeve.xbuf.XbufStringField getTriggeringMessageMessageKeyField()
           
static int getTriggeringMessageMessageKeyFieldId()
          Get the field id for 'triggeringMessageMessageKey' This method can be used to set field interests.
<T extends XString>
T
getTriggeringMessageMessageKeyTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getTriggeringMessageMessageKeyTo(XString val)
          Copies the value of 'triggeringMessageMessageKey' into the provided XString.
 XString getTriggeringMessageMessageKeyUnsafe()
          Gets the raw value of 'triggeringMessageMessageKey'.
 int getTriggeringMessageMessageSenderId()
          Gets the value of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableIntField getTriggeringMessageMessageSenderIdField()
           
static int getTriggeringMessageMessageSenderIdFieldId()
          Get the field id for 'triggeringMessageMessageSenderId' This method can be used to set field interests.
 long getTriggeringMessageMessageSno()
          Gets the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableLongField getTriggeringMessageMessageSnoField()
           
static int getTriggeringMessageMessageSnoFieldId()
          Get the field id for 'triggeringMessageMessageSno' This method can be used to set field interests.
 short getTriggeringMessageMessageViewId()
          Gets the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 com.neeve.xbuf.XbufVariableShortField getTriggeringMessageMessageViewIdField()
           
static int getTriggeringMessageMessageViewIdFieldId()
          Get the field id for 'triggeringMessageMessageViewId' This method can be used to set field interests.
 void getValidationErrors(List<XString> results, String errorPrefix)
          Collects validation errors into the provided list.
 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 hasTriggeringMessageMessageBusName()
          Checks for the presence of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 boolean hasTriggeringMessageMessageChannelId()
          Checks for the presence of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 boolean hasTriggeringMessageMessageChannelName()
          Checks for the presence of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 boolean hasTriggeringMessageMessageEncodingType()
          Checks for the presence of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 boolean hasTriggeringMessageMessageFactoryId()
          Checks for the presence of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageFlowId()
          Checks for the presence of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageKey()
          Checks for the presence of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 boolean hasTriggeringMessageMessageSenderId()
          Checks for the presence of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasTriggeringMessageMessageSno()
          Checks for the presence of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 boolean hasTriggeringMessageMessageViewId()
          Checks for the presence of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 boolean hasXRogType()
           
 TriggeringMessageMetadata init()
          Initialize an item.
 boolean isBufferBacked()
           
 boolean isDirty()
           
 boolean isReferenceCounted()
           
 boolean isValid()
          Tests if this object has any validation errors.
 void lendTriggeringMessageMessageBusName(XString val)
          Sets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 void lendTriggeringMessageMessageChannelId(XString val)
          Sets the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 void lendTriggeringMessageMessageChannelName(XString val)
          Sets the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 void lendTriggeringMessageMessageKey(XString val)
          Sets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
static void optimizeFor(int val)
           
 byte[] serializeToByteArray()
           
 ByteBuffer serializeToByteBuffer()
           
 com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
           
 int serializeToNative(long address, int addressOffset)
           
 void setAsReadOnly()
           
static void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
           
static void setFieldInterest(List<Integer> fieldIds)
           
 TriggeringMessageMetadata setPool(UtlPool<TriggeringMessageMetadata> pool)
          Set a pool item's pool.
 void setTriggeringMessageMessageBusName(String val)
          Sets the value of 'triggeringMessageMessageBusName' Field Description The bus name for the message that triggered an alert.
 void setTriggeringMessageMessageBusNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setTriggeringMessageMessageBusNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setTriggeringMessageMessageBusNameFrom(XString val)
          Copies the provided XString value into this object's 'triggeringMessageMessageBusName'.
 void setTriggeringMessageMessageChannelId(String val)
          Sets the value of 'triggeringMessageMessageChannelId' Field Description The id of the message channel for the message that triggered an alert.
 void setTriggeringMessageMessageChannelIdFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setTriggeringMessageMessageChannelIdFrom(com.neeve.xbuf.XbufStringField val)
           
 void setTriggeringMessageMessageChannelIdFrom(XString val)
          Copies the provided XString value into this object's 'triggeringMessageMessageChannelId'.
 void setTriggeringMessageMessageChannelName(String val)
          Sets the value of 'triggeringMessageMessageChannelName' Field Description The name of the message channel for the message that triggered an alert.
 void setTriggeringMessageMessageChannelNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setTriggeringMessageMessageChannelNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setTriggeringMessageMessageChannelNameFrom(XString val)
          Copies the provided XString value into this object's 'triggeringMessageMessageChannelName'.
 void setTriggeringMessageMessageEncodingType(byte val)
          Sets the value of 'triggeringMessageMessageEncodingType' Field Description A message's encoding type for the message that triggered an alert.
 void setTriggeringMessageMessageEncodingTypeFrom(com.neeve.xbuf.XbufVariableByteField val)
           
 void setTriggeringMessageMessageFactoryId(short val)
          Sets the value of 'triggeringMessageMessageFactoryId' Field Description A message's sender id for the message that triggered an alert.
 void setTriggeringMessageMessageFactoryIdFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void setTriggeringMessageMessageFlowId(int val)
          Sets the value of 'triggeringMessageMessageFlowId' Field Description A message's flow id for the message that triggered an alert.
 void setTriggeringMessageMessageFlowIdFrom(com.neeve.xbuf.XbufVariableIntField val)
           
 void setTriggeringMessageMessageKey(String val)
          Sets the value of 'triggeringMessageMessageKey' Field Description A message's key for the message that triggered an alert.
 void setTriggeringMessageMessageKeyFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setTriggeringMessageMessageKeyFrom(com.neeve.xbuf.XbufStringField val)
           
 void setTriggeringMessageMessageKeyFrom(XString val)
          Copies the provided XString value into this object's 'triggeringMessageMessageKey'.
 void setTriggeringMessageMessageSenderId(int val)
          Sets the value of 'triggeringMessageMessageSenderId' Field Description A message's sender id for the message that triggered an alert.
 void setTriggeringMessageMessageSenderIdFrom(com.neeve.xbuf.XbufVariableIntField val)
           
 void setTriggeringMessageMessageSno(long val)
          Sets the value of 'triggeringMessageMessageSno' Field Description A message's sequence number for the message that triggered an alert.
 void setTriggeringMessageMessageSnoFrom(com.neeve.xbuf.XbufVariableLongField val)
           
 void setTriggeringMessageMessageViewId(short val)
          Sets the value of 'triggeringMessageMessageViewId' Field Description A message's sender id for the message that triggered an alert.
 void setTriggeringMessageMessageViewIdFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void setXRogType(short val)
           
 void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void sync()
           
 void syncFieldBitmask()
           
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

EMPTY_ARRAY

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

Constructor Detail

TriggeringMessageMetadata

public TriggeringMessageMetadata()

TriggeringMessageMetadata

public TriggeringMessageMetadata(int initialBackingBufferSize)
Method Detail

create

public static TriggeringMessageMetadata create()

createFromSerializedXbufContainer

public static TriggeringMessageMetadata createFromSerializedXbufContainer(byte[] serializedContainer,
                                                                          com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static TriggeringMessageMetadata createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static TriggeringMessageMetadata createFrom(byte[] serializedContainer,
                                                   com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static TriggeringMessageMetadata 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)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

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()

getTriggeringMessageMessageSnoFieldId

public static final int getTriggeringMessageMessageSnoFieldId()
Get the field id for 'triggeringMessageMessageSno'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageSno()

setTriggeringMessageMessageSno

public final void setTriggeringMessageMessageSno(long val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageSno'

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageSno in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageSno

public final long getTriggeringMessageMessageSno()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageSno'

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageSno in interface ITriggeringMessageMetadata
Returns:
A message's sequence number for the message that triggered an alert.

setTriggeringMessageMessageSnoFrom

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

getTriggeringMessageMessageSnoField

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

hasTriggeringMessageMessageSno

public final boolean hasTriggeringMessageMessageSno()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageSno'

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageSno in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageSno()

clearTriggeringMessageMessageSno

public final void clearTriggeringMessageMessageSno()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageSno'

Field Description

A message's sequence number for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageSno in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageSno(long)

getTriggeringMessageMessageFlowIdFieldId

public static final int getTriggeringMessageMessageFlowIdFieldId()
Get the field id for 'triggeringMessageMessageFlowId'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageFlowId()

setTriggeringMessageMessageFlowId

public final void setTriggeringMessageMessageFlowId(int val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageFlowId'

Field Description

A message's flow id for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageFlowId

public final int getTriggeringMessageMessageFlowId()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageFlowId'

Field Description

A message's flow id for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata
Returns:
A message's flow id for the message that triggered an alert.

setTriggeringMessageMessageFlowIdFrom

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

getTriggeringMessageMessageFlowIdField

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

hasTriggeringMessageMessageFlowId

public final boolean hasTriggeringMessageMessageFlowId()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageFlowId'

Field Description

A message's flow id for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageFlowId()

clearTriggeringMessageMessageFlowId

public final void clearTriggeringMessageMessageFlowId()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageFlowId'

Field Description

A message's flow id for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageFlowId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageFlowId(int)

getTriggeringMessageMessageSenderIdFieldId

public static final int getTriggeringMessageMessageSenderIdFieldId()
Get the field id for 'triggeringMessageMessageSenderId'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageSenderId()

setTriggeringMessageMessageSenderId

public final void setTriggeringMessageMessageSenderId(int val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageSenderId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageSenderId

public final int getTriggeringMessageMessageSenderId()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageSenderId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata
Returns:
A message's sender id for the message that triggered an alert.

setTriggeringMessageMessageSenderIdFrom

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

getTriggeringMessageMessageSenderIdField

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

hasTriggeringMessageMessageSenderId

public final boolean hasTriggeringMessageMessageSenderId()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageSenderId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageSenderId()

clearTriggeringMessageMessageSenderId

public final void clearTriggeringMessageMessageSenderId()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageSenderId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageSenderId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageSenderId(int)

getTriggeringMessageMessageFactoryIdFieldId

public static final int getTriggeringMessageMessageFactoryIdFieldId()
Get the field id for 'triggeringMessageMessageFactoryId'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageFactoryId()

setTriggeringMessageMessageFactoryId

public final void setTriggeringMessageMessageFactoryId(short val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageFactoryId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageFactoryId

public final short getTriggeringMessageMessageFactoryId()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageFactoryId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata
Returns:
A message's sender id for the message that triggered an alert.

setTriggeringMessageMessageFactoryIdFrom

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

getTriggeringMessageMessageFactoryIdField

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

hasTriggeringMessageMessageFactoryId

public final boolean hasTriggeringMessageMessageFactoryId()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageFactoryId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageFactoryId()

clearTriggeringMessageMessageFactoryId

public final void clearTriggeringMessageMessageFactoryId()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageFactoryId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageFactoryId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageFactoryId(short)

getTriggeringMessageMessageViewIdFieldId

public static final int getTriggeringMessageMessageViewIdFieldId()
Get the field id for 'triggeringMessageMessageViewId'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageViewId()

setTriggeringMessageMessageViewId

public final void setTriggeringMessageMessageViewId(short val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageViewId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageViewId

public final short getTriggeringMessageMessageViewId()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageViewId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata
Returns:
A message's sender id for the message that triggered an alert.

setTriggeringMessageMessageViewIdFrom

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

getTriggeringMessageMessageViewIdField

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

hasTriggeringMessageMessageViewId

public final boolean hasTriggeringMessageMessageViewId()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageViewId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageViewId()

clearTriggeringMessageMessageViewId

public final void clearTriggeringMessageMessageViewId()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageViewId'

Field Description

A message's sender id for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageViewId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageViewId(short)

getTriggeringMessageMessageEncodingTypeFieldId

public static final int getTriggeringMessageMessageEncodingTypeFieldId()
Get the field id for 'triggeringMessageMessageEncodingType'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageEncodingType()

setTriggeringMessageMessageEncodingType

public final void setTriggeringMessageMessageEncodingType(byte val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageEncodingType'

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageEncodingType

public final byte getTriggeringMessageMessageEncodingType()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageEncodingType'

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata
Returns:
A message's encoding type for the message that triggered an alert.

setTriggeringMessageMessageEncodingTypeFrom

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

getTriggeringMessageMessageEncodingTypeField

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

hasTriggeringMessageMessageEncodingType

public final boolean hasTriggeringMessageMessageEncodingType()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageEncodingType'

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageEncodingType()

clearTriggeringMessageMessageEncodingType

public final void clearTriggeringMessageMessageEncodingType()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageEncodingType'

Field Description

A message's encoding type for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageEncodingType in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageEncodingType(byte)

getTriggeringMessageMessageBusNameFieldId

public static final int getTriggeringMessageMessageBusNameFieldId()
Get the field id for 'triggeringMessageMessageBusName'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageBusName()

setTriggeringMessageMessageBusName

public final void setTriggeringMessageMessageBusName(String val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageBusName'

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:
setTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageBusName

public final String getTriggeringMessageMessageBusName()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageBusName'

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:
getTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata
Returns:
The bus name for the message that triggered an alert.

lendTriggeringMessageMessageBusName

public final void lendTriggeringMessageMessageBusName(XString val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageBusName'

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:
lendTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

setTriggeringMessageMessageBusNameFrom

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

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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

Specified by:
setTriggeringMessageMessageBusNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageBusNameTo

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

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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:
getTriggeringMessageMessageBusNameTo in interface ITriggeringMessageMetadata
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.

setTriggeringMessageMessageBusNameFrom

public final void setTriggeringMessageMessageBusNameFrom(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the provided XString value into this object's 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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

Specified by:
setTriggeringMessageMessageBusNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageBusNameTo

public final void getTriggeringMessageMessageBusNameTo(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the value of 'triggeringMessageMessageBusName' into the provided XString.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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

Specified by:
getTriggeringMessageMessageBusNameTo in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageBusName()

getTriggeringMessageMessageBusNameUnsafe

public final XString getTriggeringMessageMessageBusNameUnsafe()
Description copied from interface: ITriggeringMessageMetadata
Gets the raw value of 'triggeringMessageMessageBusName'.

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

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:
getTriggeringMessageMessageBusNameUnsafe in interface ITriggeringMessageMetadata
Returns:
the field's raw value
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageBusName()

setTriggeringMessageMessageBusNameFrom

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

getTriggeringMessageMessageBusNameField

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

hasTriggeringMessageMessageBusName

public final boolean hasTriggeringMessageMessageBusName()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageBusName'

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:
hasTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageBusName()

clearTriggeringMessageMessageBusName

public final void clearTriggeringMessageMessageBusName()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageBusName'

Field Description

The bus name for the message that triggered an alert.

Field Type Semantics

A String representing a message bus name.

Specified by:
clearTriggeringMessageMessageBusName in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageBusName(String)

getTriggeringMessageMessageChannelNameFieldId

public static final int getTriggeringMessageMessageChannelNameFieldId()
Get the field id for 'triggeringMessageMessageChannelName'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageChannelName()

setTriggeringMessageMessageChannelName

public final void setTriggeringMessageMessageChannelName(String val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageChannelName'

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageChannelName

public final String getTriggeringMessageMessageChannelName()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageChannelName'

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata
Returns:
The name of the message channel for the message that triggered an alert.

lendTriggeringMessageMessageChannelName

public final void lendTriggeringMessageMessageChannelName(XString val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageChannelName'

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:
lendTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

setTriggeringMessageMessageChannelNameFrom

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

Field Description

The name of the message channel for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageChannelNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelNameTo

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

Field Description

The name of the message channel for the message that triggered an alert.

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:
getTriggeringMessageMessageChannelNameTo in interface ITriggeringMessageMetadata
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.

setTriggeringMessageMessageChannelNameFrom

public final void setTriggeringMessageMessageChannelNameFrom(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the provided XString value into this object's 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageChannelNameFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelNameTo

public final void getTriggeringMessageMessageChannelNameTo(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the value of 'triggeringMessageMessageChannelName' into the provided XString.

Field Description

The name of the message channel for the message that triggered an alert.

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

Specified by:
getTriggeringMessageMessageChannelNameTo in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelName()

getTriggeringMessageMessageChannelNameUnsafe

public final XString getTriggeringMessageMessageChannelNameUnsafe()
Description copied from interface: ITriggeringMessageMetadata
Gets the raw value of 'triggeringMessageMessageChannelName'.

Field Description

The name of the message channel for the message that triggered an alert.

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:
getTriggeringMessageMessageChannelNameUnsafe in interface ITriggeringMessageMetadata
Returns:
the field's raw value
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelName()

setTriggeringMessageMessageChannelNameFrom

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

getTriggeringMessageMessageChannelNameField

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

hasTriggeringMessageMessageChannelName

public final boolean hasTriggeringMessageMessageChannelName()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageChannelName'

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelName()

clearTriggeringMessageMessageChannelName

public final void clearTriggeringMessageMessageChannelName()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageChannelName'

Field Description

The name of the message channel for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageChannelName in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageChannelName(String)

getTriggeringMessageMessageChannelIdFieldId

public static final int getTriggeringMessageMessageChannelIdFieldId()
Get the field id for 'triggeringMessageMessageChannelId'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageChannelId()

setTriggeringMessageMessageChannelId

public final void setTriggeringMessageMessageChannelId(String val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageChannelId'

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageChannelId

public final String getTriggeringMessageMessageChannelId()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageChannelId'

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata
Returns:
The id of the message channel for the message that triggered an alert.

lendTriggeringMessageMessageChannelId

public final void lendTriggeringMessageMessageChannelId(XString val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageChannelId'

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:
lendTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

setTriggeringMessageMessageChannelIdFrom

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

Field Description

The id of the message channel for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageChannelIdFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelIdTo

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

Field Description

The id of the message channel for the message that triggered an alert.

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:
getTriggeringMessageMessageChannelIdTo in interface ITriggeringMessageMetadata
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.

setTriggeringMessageMessageChannelIdFrom

public final void setTriggeringMessageMessageChannelIdFrom(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the provided XString value into this object's 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageChannelIdFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageChannelIdTo

public final void getTriggeringMessageMessageChannelIdTo(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the value of 'triggeringMessageMessageChannelId' into the provided XString.

Field Description

The id of the message channel for the message that triggered an alert.

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

Specified by:
getTriggeringMessageMessageChannelIdTo in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelId()

getTriggeringMessageMessageChannelIdUnsafe

public final XString getTriggeringMessageMessageChannelIdUnsafe()
Description copied from interface: ITriggeringMessageMetadata
Gets the raw value of 'triggeringMessageMessageChannelId'.

Field Description

The id of the message channel for the message that triggered an alert.

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:
getTriggeringMessageMessageChannelIdUnsafe in interface ITriggeringMessageMetadata
Returns:
the field's raw value
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelId()

setTriggeringMessageMessageChannelIdFrom

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

getTriggeringMessageMessageChannelIdField

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

hasTriggeringMessageMessageChannelId

public final boolean hasTriggeringMessageMessageChannelId()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageChannelId'

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageChannelId()

clearTriggeringMessageMessageChannelId

public final void clearTriggeringMessageMessageChannelId()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageChannelId'

Field Description

The id of the message channel for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageChannelId in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageChannelId(String)

getTriggeringMessageMessageKeyFieldId

public static final int getTriggeringMessageMessageKeyFieldId()
Get the field id for 'triggeringMessageMessageKey'

This method can be used to set field interests.

See Also:
getTriggeringMessageMessageKey()

setTriggeringMessageMessageKey

public final void setTriggeringMessageMessageKey(String val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageKey'

Field Description

A message's key for the message that triggered an alert.

Specified by:
setTriggeringMessageMessageKey in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

getTriggeringMessageMessageKey

public final String getTriggeringMessageMessageKey()
Description copied from interface: ITriggeringMessageMetadata
Gets the value of 'triggeringMessageMessageKey'

Field Description

A message's key for the message that triggered an alert.

Specified by:
getTriggeringMessageMessageKey in interface ITriggeringMessageMetadata
Returns:
A message's key for the message that triggered an alert.

lendTriggeringMessageMessageKey

public final void lendTriggeringMessageMessageKey(XString val)
Description copied from interface: ITriggeringMessageMetadata
Sets the value of 'triggeringMessageMessageKey'

Field Description

A message's key for the message that triggered an alert.

Specified by:
lendTriggeringMessageMessageKey in interface ITriggeringMessageMetadata
Parameters:
val - The value to set.

setTriggeringMessageMessageKeyFrom

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

Field Description

A message's key for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageKeyFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageKeyTo

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

Field Description

A message's key for the message that triggered an alert.

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:
getTriggeringMessageMessageKeyTo in interface ITriggeringMessageMetadata
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.

setTriggeringMessageMessageKeyFrom

public final void setTriggeringMessageMessageKeyFrom(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the provided XString value into this object's 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

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

Specified by:
setTriggeringMessageMessageKeyFrom in interface ITriggeringMessageMetadata

getTriggeringMessageMessageKeyTo

public final void getTriggeringMessageMessageKeyTo(XString val)
Description copied from interface: ITriggeringMessageMetadata
Copies the value of 'triggeringMessageMessageKey' into the provided XString.

Field Description

A message's key for the message that triggered an alert.

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

Specified by:
getTriggeringMessageMessageKeyTo in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageKey()

getTriggeringMessageMessageKeyUnsafe

public final XString getTriggeringMessageMessageKeyUnsafe()
Description copied from interface: ITriggeringMessageMetadata
Gets the raw value of 'triggeringMessageMessageKey'.

Field Description

A message's key for the message that triggered an alert.

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:
getTriggeringMessageMessageKeyUnsafe in interface ITriggeringMessageMetadata
Returns:
the field's raw value
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageKey()

setTriggeringMessageMessageKeyFrom

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

getTriggeringMessageMessageKeyField

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

hasTriggeringMessageMessageKey

public final boolean hasTriggeringMessageMessageKey()
Description copied from interface: ITriggeringMessageMetadata
Checks for the presence of 'triggeringMessageMessageKey'

Field Description

A message's key for the message that triggered an alert.

Specified by:
hasTriggeringMessageMessageKey in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.getTriggeringMessageMessageKey()

clearTriggeringMessageMessageKey

public final void clearTriggeringMessageMessageKey()
Description copied from interface: ITriggeringMessageMetadata
Clears the value of 'triggeringMessageMessageKey'

Field Description

A message's key for the message that triggered an alert.

Specified by:
clearTriggeringMessageMessageKey in interface ITriggeringMessageMetadata
See Also:
ITriggeringMessageMetadata.setTriggeringMessageMessageKey(String)

isDirty

public final boolean isDirty()

createSchema

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

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

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

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                                   int addressOffset)

deserializeFromIOElasticBuffer

public final TriggeringMessageMetadata deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                      int offset,
                                                                      int length,
                                                                      com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final TriggeringMessageMetadata deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                      int offset,
                                                                      int length)

deserializeFromByteArray

public final TriggeringMessageMetadata deserializeFromByteArray(byte[] array,
                                                                com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final TriggeringMessageMetadata deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final TriggeringMessageMetadata deserializeFromByteBuffer(ByteBuffer buffer,
                                                                 com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final TriggeringMessageMetadata deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final TriggeringMessageMetadata deserializeFromNative(long address,
                                                             int offset,
                                                             int length,
                                                             com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final TriggeringMessageMetadata deserializeFromNative(long address,
                                                             int offset,
                                                             int length)

sync

public final void sync()

desync

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

init

public final TriggeringMessageMetadata init()
Description copied from interface: UtlPool.Item
Initialize an item.

This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.

Specified by:
init in interface UtlPool.Item<TriggeringMessageMetadata>
Returns:
Return 'this' object for method invocation chaining.

setPool

public final TriggeringMessageMetadata setPool(UtlPool<TriggeringMessageMetadata> pool)
Description copied from interface: UtlPool.Item
Set a pool item's pool.

This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.

Specified by:
setPool in interface UtlPool.Item<TriggeringMessageMetadata>
Returns:
Return 'this' object for method invocation chaining.

getPool

public final UtlPool<TriggeringMessageMetadata> getPool()
Description copied from interface: UtlPool.Item
Get a pool item's pool.

This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

Specified by:
getPool in interface UtlPool.Item<TriggeringMessageMetadata>
Returns:
the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final TriggeringMessageMetadata acquire()

getOwnerCount

public final int getOwnerCount()

dispose

public final void dispose()

clone

public final Object clone()
Creates a clone of this object.

This method differs from the copy() method in that:

Overrides:
clone in class Object

copy

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

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

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

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.

Returns:
The copied entity.

copyInto

public final void copyInto(TriggeringMessageMetadata copy)
Copies the contents of this TriggeringMessageMetadata 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 TriggeringMessageMetadata's embedded entity fields.

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

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.

Parameters:
copy - The target into which to copy.

isValid

public final boolean isValid()
Description copied from interface: IRogValidatable
Tests if this object has any validation errors.

Specified by:
isValid in interface IRogValidatable

getValidationErrors

public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
Description copied from interface: IRogValidatable
Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.

Specified by:
getValidationErrors in interface IRogValidatable
Parameters:
results - A results list into which validation errors will be collected.
errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.

toString

public final String toString()
Overrides:
toString in class Object


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