com.neeve.server.mon
Class SrvMonAppBusBindingInfo

java.lang.Object
  com.neeve.server.mon.SrvMonAppBusBindingInfo

All Implemented Interfaces:

IRogValidatable, ISrvMonAppBusBindingInfo, UtlPool.Item<SrvMonAppBusBindingInfo>, 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=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=102)
public final class SrvMonAppBusBindingInfo
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonAppBusBindingInfo>, ISrvMonAppBusBindingInfo

Holds information about a message bus binding.

Nested Class Summary

static class	SrvMonAppBusBindingInfo.Field The SrvMonAppBusBindingInfo xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonAppBusBindingInfo.ListField The SrvMonAppBusBindingInfo list field (used internally when this entity is used as an array field of another entity).

Field Summary

static SrvMonAppBusBindingInfo[]

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

Constructor Summary

SrvMonAppBusBindingInfo()

SrvMonAppBusBindingInfo(int initialBackingBufferSize)

Method Summary

SrvMonAppBusBindingInfo	acquire()
void	addChannelsInfo(SrvMonAppBusChannelInfo val) Adds the provided value to the list of 'channelsInfo' values.
void	clearChannelsInfo() Clears the value of 'channelsInfo' Field Description Holds channel info for the bus channels.
void	clearContent()
void	clearName() Clears the value of 'name' Field Description The bus name.
void	clearState() Clears the value of 'state' Field Description The current bus state.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonAppBusBindingInfo	copy() Creates a copy of this SrvMonAppBusBindingInfo.
void	copyInto(SrvMonAppBusBindingInfo copy) Copies the contents of this SrvMonAppBusBindingInfo into the target.
static SrvMonAppBusBindingInfo	create()
static SrvMonAppBusBindingInfo	createFrom(byte[] serializedContainer)
static SrvMonAppBusBindingInfo	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonAppBusBindingInfo	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonAppBusBindingInfo	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonAppBusBindingInfo	deserializeFromByteArray(byte[] array)
SrvMonAppBusBindingInfo	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppBusBindingInfo	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonAppBusBindingInfo	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppBusBindingInfo	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonAppBusBindingInfo	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonAppBusBindingInfo	deserializeFromNative(long address, int offset, int length)
SrvMonAppBusBindingInfo	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()
SrvMonAppBusChannelInfo[]	getChannelsInfo() Gets the value of 'channelsInfo' If the field is not set this method will return null.
SrvMonAppBusChannelInfo[]	getChannelsInfoEmptyIfNull() Gets the value of 'channelsInfo' or an empty array if the value is null or not set.
static int	getChannelsInfoFieldId() Get the field id for 'channelsInfo' This method can be used to set field interests.
XIterator<SrvMonAppBusChannelInfo>	getChannelsInfoIterator() Gets the value of 'channelsInfo' as iterator of values.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
boolean	getIsReadOnly()
String	getName() Gets the value of 'name' Field Description The bus name.
com.neeve.xbuf.XbufStringField	getNameField()
static int	getNameFieldId() Get the field id for 'name' This method can be used to set field interests.
<T extends XString> T	getNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getNameTo(XString val) Copies the value of 'name' into the provided XString.
XString	getNameUnsafe() Gets the raw value of 'name'.
int	getOwnerCount()
UtlPool<SrvMonAppBusBindingInfo>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
SrvMonAppBusBindingState	getState() Gets the value of 'state' Field Description The current bus state.
com.neeve.xbuf.XbufVariableEnumField<SrvMonAppBusBindingState>	getStateField()
static int	getStateFieldId() Get the field id for 'state' 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	hasName() Checks for the presence of 'name' Field Description The bus name.
boolean	hasState() Checks for the presence of 'state' Field Description The current bus state.
boolean	hasXRogType()
SrvMonAppBusBindingInfo	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendChannelsInfo(SrvMonAppBusChannelInfo val) Adds the provided value to the list of 'channelsInfo' values and acquires a reference to it.
void	lendChannelsInfo(SrvMonAppBusChannelInfo[] val) Lends the value of 'channelsInfo' Field Description Holds channel info for the bus channels.
void	lendChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val) Sets the value of 'channelsInfo' by lending the values from the provided iterator.
void	lendName(XString val) Sets the value of 'name' Field Description The bus name.
static void	optimizeFor(int val)
byte[]	serializeToByteArray()
ByteBuffer	serializeToByteBuffer()
com.neeve.io.IOBuffer	serializeToIOBuffer(boolean useNative)
int	serializeToNative(long address, int addressOffset)
void	setAsReadOnly()
void	setChannelsInfo(SrvMonAppBusChannelInfo[] val) Sets the value of 'channelsInfo' Field Description Holds channel info for the bus channels.
void	setChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val) Sets the value of 'channelsInfo' using the values from the provided iterator.
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setName(String val) Sets the value of 'name' Field Description The bus name.
void	setNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setNameFrom(com.neeve.xbuf.XbufStringField val)
void	setNameFrom(XString val) Copies the provided XString value into this object's 'name'.
SrvMonAppBusBindingInfo	setPool(UtlPool<SrvMonAppBusBindingInfo> pool) Set a pool item's pool.
void	setState(SrvMonAppBusBindingState val) Sets the value of 'state' Field Description The current bus state.
void	setStateFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppBusBindingState> val)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonAppBusChannelInfo[]	takeChannelsInfo() Takes the value of 'channelsInfo' Field Description Holds channel info for the bus channels.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonAppBusBindingInfo[] EMPTY_ARRAY

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

Constructor Detail

SrvMonAppBusBindingInfo

public SrvMonAppBusBindingInfo()

SrvMonAppBusBindingInfo

public SrvMonAppBusBindingInfo(int initialBackingBufferSize)

Method Detail

create

public static SrvMonAppBusBindingInfo create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonAppBusBindingInfo createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

public static SrvMonAppBusBindingInfo 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()

getStateFieldId

public static final int getStateFieldId()

Get the field id for 'state'

This method can be used to set field interests.

See Also:

getState()

setState

public final void setState(SrvMonAppBusBindingState val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'state'

Field Description

The current bus state.

Specified by:

setState in interface ISrvMonAppBusBindingInfo

Parameters:

val - The value to set.

setStateFrom

public final void setStateFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonAppBusBindingState> val)

getStateField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonAppBusBindingState> getStateField()

getState

public final SrvMonAppBusBindingState getState()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the value of 'state'

Field Description

The current bus state.

Specified by:

getState in interface ISrvMonAppBusBindingInfo

Returns:

The current bus state.

hasState

public final boolean hasState()

Description copied from interface: ISrvMonAppBusBindingInfo

Checks for the presence of 'state'

Field Description

The current bus state.

Specified by:

hasState in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.getState()

clearState

public final void clearState()

Description copied from interface: ISrvMonAppBusBindingInfo

Clears the value of 'state'

Field Description

The current bus state.

Specified by:

clearState in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.setState(SrvMonAppBusBindingState)

getNameFieldId

public static final int getNameFieldId()

Get the field id for 'name'

This method can be used to set field interests.

See Also:

getName()

setName

public final void setName(String val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'name'

Field Description

The bus name.

Specified by:

setName in interface ISrvMonAppBusBindingInfo

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the value of 'name'

Field Description

The bus name.

Specified by:

getName in interface ISrvMonAppBusBindingInfo

Returns:

The bus name.

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'name'

Field Description

The bus name.

Specified by:

lendName in interface ISrvMonAppBusBindingInfo

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonAppBusBindingInfo

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

Field Description

The bus name.

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

Specified by:

setNameFrom in interface ISrvMonAppBusBindingInfo

getNameTo

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

Description copied from interface: ISrvMonAppBusBindingInfo

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

Field Description

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

getNameTo in interface ISrvMonAppBusBindingInfo

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.

setNameFrom

public final void setNameFrom(XString val)

Description copied from interface: ISrvMonAppBusBindingInfo

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

Field Description

The bus name.

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

Specified by:

setNameFrom in interface ISrvMonAppBusBindingInfo

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonAppBusBindingInfo

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

Field Description

The bus name.

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

Specified by:

getNameTo in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the raw value of 'name'.

Field Description

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

getNameUnsafe in interface ISrvMonAppBusBindingInfo

Returns:

the field's raw value

See Also:

ISrvMonAppBusBindingInfo.getName()

setNameFrom

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

getNameField

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

hasName

public final boolean hasName()

Description copied from interface: ISrvMonAppBusBindingInfo

Checks for the presence of 'name'

Field Description

The bus name.

Specified by:

hasName in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonAppBusBindingInfo

Clears the value of 'name'

Field Description

The bus name.

Specified by:

clearName in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.setName(String)

getChannelsInfoFieldId

public static final int getChannelsInfoFieldId()

Get the field id for 'channelsInfo'

This method can be used to set field interests.

See Also:

getChannelsInfo()

setChannelsInfo

public final void setChannelsInfo(SrvMonAppBusChannelInfo[] val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'channelsInfo'

Field Description

Holds channel info for the bus channels.

Specified by:

setChannelsInfo in interface ISrvMonAppBusBindingInfo

Parameters:

val - The value to set.

setChannelsInfoFrom

public final void setChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'channelsInfo' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'channelsInfo' accessor can copy the values without iteration.

Field Description

Holds channel info for the bus channels.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppBusBindingInfo.setChannelsInfo(SrvMonAppBusChannelInfo[]) with a value of null.

Specified by:

setChannelsInfoFrom in interface ISrvMonAppBusBindingInfo

Parameters:

val - the values to set.

lendChannelsInfoFrom

public final void lendChannelsInfoFrom(XIterator<SrvMonAppBusChannelInfo> val)

Description copied from interface: ISrvMonAppBusBindingInfo

Sets the value of 'channelsInfo' by lending the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'channelsInfo' accessor can copy the values without iteration.

Field Description

Holds channel info for the bus channels.

NOTE:
Passing a null or empty list has the same affect as calling ISrvMonAppBusBindingInfo.setChannelsInfo(SrvMonAppBusChannelInfo[]) with a value of null.

Specified by:

lendChannelsInfoFrom in interface ISrvMonAppBusBindingInfo

Parameters:

val - the values to set.

lendChannelsInfo

public final void lendChannelsInfo(SrvMonAppBusChannelInfo[] val)

Description copied from interface: ISrvMonAppBusBindingInfo

Lends the value of 'channelsInfo'

Field Description

Holds channel info for the bus channels.

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Specified by:

lendChannelsInfo in interface ISrvMonAppBusBindingInfo

Parameters:

val - the value to 'lend' to lend.

addChannelsInfo

public final void addChannelsInfo(SrvMonAppBusChannelInfo val)

Description copied from interface: ISrvMonAppBusBindingInfo

Adds the provided value to the list of 'channelsInfo' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'channelsInfo' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Holds channel info for the bus channels.

Specified by:

addChannelsInfo in interface ISrvMonAppBusBindingInfo

Parameters:

val - the value to add.

lendChannelsInfo

public final void lendChannelsInfo(SrvMonAppBusChannelInfo val)

Description copied from interface: ISrvMonAppBusBindingInfo

Adds the provided value to the list of 'channelsInfo' values and acquires a reference to it.

Lending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'channelsInfo' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

Holds channel info for the bus channels.

Specified by:

lendChannelsInfo in interface ISrvMonAppBusBindingInfo

Parameters:

val - the value to add.

getChannelsInfo

public final SrvMonAppBusChannelInfo[] getChannelsInfo()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the value of 'channelsInfo'

If the field is not set this method will return null.

Field Description

Holds channel info for the bus channels.

Specified by:

getChannelsInfo in interface ISrvMonAppBusBindingInfo

Returns:

Holds channel info for the bus channels. If the field is not set this method will return null.

getChannelsInfoEmptyIfNull

public final SrvMonAppBusChannelInfo[] getChannelsInfoEmptyIfNull()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the value of 'channelsInfo' or an empty array if the value is null or not set.

Field Description

Holds channel info for the bus channels.

Specified by:

getChannelsInfoEmptyIfNull in interface ISrvMonAppBusBindingInfo

Returns:

Holds channel info for the bus channels. or an empty array if null if not set.

See Also:

ISrvMonAppBusBindingInfo.getChannelsInfo()

getChannelsInfoIterator

public final XIterator<SrvMonAppBusChannelInfo> getChannelsInfoIterator()

Description copied from interface: ISrvMonAppBusBindingInfo

Gets the value of 'channelsInfo' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

The elements returned by this iterator are owned by and pooled along with this object. The caller. must call acquire() on each returned object that this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(XIterator method can perform a direct copy of the underlying values without iteration.

Field Description

Holds channel info for the bus channels.

Specified by:

getChannelsInfoIterator in interface ISrvMonAppBusBindingInfo

Returns:

An iterator containing this field values.

takeChannelsInfo

public final SrvMonAppBusChannelInfo[] takeChannelsInfo()

Description copied from interface: ISrvMonAppBusBindingInfo

Takes the value of 'channelsInfo'

Field Description

Holds channel info for the bus channels.

NOTE:
A nested entity reference returned by ISrvMonAppBusBindingInfo.getChannelsInfo() is only valid until the entity is disposed i.e. the act of getting an entity does not transfer ownership of the entity to the application A message disposes of its reference to its contained entities when it is disposed itself.

An AEP engine disposes a message on return from its message handler. Therefore, applications working with AEP engines that wish to hold onto a nested entity reference post return from its containing message's handler must either acquire a reference to the container message or 'take' the nested entity itself from the container message. The act of 'taking' an entity differs from 'getting' an entity in that 'take' does what is necessary to ensure that the entity contents are not cleared and the entity not disposed when the message itself is disposed. For a taken entity to be disposed, the application must explicitly dispose it when done working with it.

Specified by:

takeChannelsInfo in interface ISrvMonAppBusBindingInfo

Returns:

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

clearChannelsInfo

public final void clearChannelsInfo()

Description copied from interface: ISrvMonAppBusBindingInfo

Clears the value of 'channelsInfo'

Field Description

Holds channel info for the bus channels.

Specified by:

clearChannelsInfo in interface ISrvMonAppBusBindingInfo

See Also:

ISrvMonAppBusBindingInfo.setChannelsInfo(SrvMonAppBusChannelInfo[])

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 SrvMonAppBusBindingInfo deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                    int offset,
                                                                    int length,
                                                                    com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonAppBusBindingInfo deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonAppBusBindingInfo deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

public final SrvMonAppBusBindingInfo 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 SrvMonAppBusBindingInfo 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<SrvMonAppBusBindingInfo>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonAppBusBindingInfo setPool(UtlPool<SrvMonAppBusBindingInfo> 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<SrvMonAppBusBindingInfo>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonAppBusBindingInfo> 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<SrvMonAppBusBindingInfo>

Returns:

the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonAppBusBindingInfo 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:

• For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
• The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.

Overrides:

clone in class Object

copy

public final SrvMonAppBusBindingInfo copy()

Creates a copy of this SrvMonAppBusBindingInfo.

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

The returned copy will be writeable even if this SrvMonAppBusBindingInfo 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(SrvMonAppBusBindingInfo copy)

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

The returned copy will be writeable even if this SrvMonAppBusBindingInfo 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