com.neeve.server.mon

Class SrvMonUserSeriesStat

java.lang.Object

com.neeve.server.mon.SrvMonUserSeriesStat

All Implemented Interfaces:

IRogValidatable, ISrvMonUserSeriesStat, UtlPool.Item<SrvMonUserSeriesStat>, com.neeve.xbuf.IXbufDesyncer

@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Fri Dec 05 13:32:50 UTC 2025")
 @AdmGenerated(encoding="Xbuf",
              compatLevel="4.1.0",
              admVersion="Unknown Version",
              date="12/5/25 1:32 PM",
              buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)")
 @AdmFactoryInfo(factoryClass=SrvMonFactory.class,
                vfid=32,
                ofid=32,
                typeId=219)
public final class SrvMonUserSeriesStat
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonUserSeriesStat>, ISrvMonUserSeriesStat

An application defined latency collection statistic.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
intSeries	SrvMonIntSeries	18	The collected int series data for an INT series. This field should only be set when the series type is set to SrvMonSeriesType.INT.
longSeries	SrvMonLongSeries	19	The collected long series data for an LONG series. This field should only be set when the series type is set to SrvMonSeriesType.LONG.
name	String	16	The name of the statistic.
seriesType	SrvMonSeriesType	17	The type of the series data collected.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SrvMonUserSeriesStat.Field The SrvMonUserSeriesStat xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonUserSeriesStat.ListField The SrvMonUserSeriesStat list field (used internally when this entity is used as an array field of another entity).

Field Summary

Fields

Modifier and Type	Field and Description
static SrvMonUserSeriesStat[]	EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors

Constructor and Description
SrvMonUserSeriesStat()
SrvMonUserSeriesStat(int initialBackingBufferSize)

Method Summary

Modifier and Type	Method and Description
SrvMonUserSeriesStat	acquire()
void	clearContent()
void	clearIntSeries() Clears the value of 'intSeries'.
void	clearLongSeries() Clears the value of 'longSeries'.
void	clearName() Clears the value of 'name'.
void	clearSeriesType() Clears the value of 'seriesType'.
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonUserSeriesStat	copy() Creates a copy of this SrvMonUserSeriesStat.
void	copyInto(SrvMonUserSeriesStat copy) Copies the contents of this SrvMonUserSeriesStat into the target.
static SrvMonUserSeriesStat	create()
static SrvMonUserSeriesStat	createFrom(byte[] serializedContainer)
static SrvMonUserSeriesStat	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonUserSeriesStat	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonUserSeriesStat	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonUserSeriesStat	deserializeFromByteArray(byte[] array)
SrvMonUserSeriesStat	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserSeriesStat	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonUserSeriesStat	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserSeriesStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonUserSeriesStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserSeriesStat	deserializeFromNative(long address, int offset, int length)
SrvMonUserSeriesStat	deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
int	desync(PktBuffer buffer, int pos, boolean frameOnly) Desync fields from a buffer
void	desyncFieldBitmask()
void	dispose()
PktBuffer	getBackingBuffer()
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
SrvMonIntSeries	getIntSeries() Gets the value of 'intSeries'.
static int	getIntSeriesFieldId()
void	getIntSeriesTo(SrvMonIntSeries to) Copies the value of SrvMonIntSeries into the provided value.
boolean	getIsReadOnly()
SrvMonLongSeries	getLongSeries() Gets the value of 'longSeries'.
static int	getLongSeriesFieldId()
void	getLongSeriesTo(SrvMonLongSeries to) Copies the value of SrvMonLongSeries into the provided value.
String	getName() Gets the value of 'name'.
com.neeve.xbuf.XbufStringField	getNameField()
static int	getNameFieldId()
<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<SrvMonUserSeriesStat>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
SrvMonSeriesType	getSeriesType() Gets the value of 'seriesType'.
com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType>	getSeriesTypeField()
static int	getSeriesTypeFieldId()
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
short	getXRogType()
Short	getXRogTypeAsObject()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId()
boolean	hasIntSeries() Checks for the presence of 'intSeries'.
boolean	hasLongSeries() Checks for the presence of 'longSeries'.
boolean	hasName() Checks for the presence of 'name'.
boolean	hasSeriesType() Checks for the presence of 'seriesType'.
boolean	hasXRogType()
SrvMonUserSeriesStat	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendIntSeries(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendLongSeries(SrvMonLongSeries val) 'Lends' a reference of the SrvMonLongSeries to the message for this field.
void	lendName(XString val) Lends the value of 'name' to this object.
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)
void	setIntSeries(SrvMonIntSeries val) Sets the value of 'intSeries'.
void	setLongSeries(SrvMonLongSeries val) Sets the value of 'longSeries'.
void	setName(String val) Sets the value of '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'.
SrvMonUserSeriesStat	setPool(UtlPool<SrvMonUserSeriesStat> pool) Set a pool item's pool.
void	setPreserializedFields(PktBuffer buffer)
void	setSeriesType(SrvMonSeriesType val) Sets the value of 'seriesType'.
void	setSeriesTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> val)
void	setXRogType(short val)
void	setXRogTypeAsObject(Short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	sync()
void	syncFieldBitmask()
SrvMonIntSeries	takeIntSeries() 'Takes' a reference to the intSeries field from the message.
SrvMonLongSeries	takeLongSeries() 'Takes' a reference to the longSeries field from the message.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final SrvMonUserSeriesStat[] EMPTY_ARRAY

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

Constructor Detail

SrvMonUserSeriesStat

public SrvMonUserSeriesStat()

SrvMonUserSeriesStat

public SrvMonUserSeriesStat(int initialBackingBufferSize)

Method Detail

create

public static SrvMonUserSeriesStat create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonUserSeriesStat createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

setPreserializedFields

public final void setPreserializedFields(PktBuffer buffer)

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

setXRogType

public final void setXRogType(short val)

setXRogTypeAsObject

public final void setXRogTypeAsObject(Short val)

getXRogType

public final short getXRogType()

getXRogTypeAsObject

public final Short getXRogTypeAsObject()

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

getSeriesTypeFieldId

public static final int getSeriesTypeFieldId()

setSeriesType

public final void setSeriesType(SrvMonSeriesType val)

Description copied from interface: ISrvMonUserSeriesStat

Sets the value of 'seriesType'.

Field Description

The type of the series data collected.

Specified by:

setSeriesType in interface ISrvMonUserSeriesStat

Parameters:

val - The value to set.

setSeriesTypeFrom

public final void setSeriesTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> val)

getSeriesTypeField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> getSeriesTypeField()

getSeriesType

public final SrvMonSeriesType getSeriesType()

Description copied from interface: ISrvMonUserSeriesStat

Gets the value of 'seriesType'.

Field Description

The type of the series data collected.

Specified by:

getSeriesType in interface ISrvMonUserSeriesStat

Returns:

The type of the series data collected.

hasSeriesType

public final boolean hasSeriesType()

Description copied from interface: ISrvMonUserSeriesStat

Checks for the presence of 'seriesType'.

Field Description

The type of the series data collected.

Specified by:

hasSeriesType in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.getSeriesType()

clearSeriesType

public final void clearSeriesType()

Description copied from interface: ISrvMonUserSeriesStat

Clears the value of 'seriesType'.

Field Description

The type of the series data collected.

Specified by:

clearSeriesType in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.setSeriesType(SrvMonSeriesType)

getNameFieldId

public static final int getNameFieldId()

setName

public final void setName(String val)

Description copied from interface: ISrvMonUserSeriesStat

Sets the value of 'name'.

Field Description

The name of the statistic.

Specified by:

setName in interface ISrvMonUserSeriesStat

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonUserSeriesStat

Gets the value of 'name'.

Field Description

The name of the statistic.

Specified by:

getName in interface ISrvMonUserSeriesStat

Returns:

The name of the statistic

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonUserSeriesStat

Lends the value of 'name' to this object.

This method is equivalent to setName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The name of the statistic.

Usage Notes

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

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Specified by:

lendName in interface ISrvMonUserSeriesStat

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The name of the statistic.

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

getNameTo

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

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The name of the statistic.

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 ISrvMonUserSeriesStat

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

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

Field Description

The name of the statistic.

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

Specified by:

setNameFrom in interface ISrvMonUserSeriesStat

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The name of the statistic.

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

Specified by:

getNameTo in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonUserSeriesStat

Gets the raw value of 'name'.

Field Description

The name of the statistic.

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 ISrvMonUserSeriesStat

Returns:

the field's raw value

See Also:

ISrvMonUserSeriesStat.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: ISrvMonUserSeriesStat

Checks for the presence of 'name'.

Field Description

The name of the statistic.

Specified by:

hasName in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonUserSeriesStat

Clears the value of 'name'.

Field Description

The name of the statistic.

Specified by:

clearName in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.setName(String)

getIntSeriesFieldId

public static final int getIntSeriesFieldId()

setIntSeries

public final void setIntSeries(SrvMonIntSeries val)

Description copied from interface: ISrvMonUserSeriesStat

Sets the value of 'intSeries'.

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

Specified by:

setIntSeries in interface ISrvMonUserSeriesStat

Parameters:

val - The value to set.

lendIntSeries

public final void lendIntSeries(SrvMonIntSeries val)

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

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:

lendIntSeries in interface ISrvMonUserSeriesStat

Parameters:

val - the value to 'lend' to lend.

getIntSeries

public final SrvMonIntSeries getIntSeries()

Description copied from interface: ISrvMonUserSeriesStat

Gets the value of 'intSeries'.

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

Specified by:

getIntSeries in interface ISrvMonUserSeriesStat

Returns:

The collected int series data for an INT series.

getIntSeriesTo

public final void getIntSeriesTo(SrvMonIntSeries to)

Description copied from interface: ISrvMonUserSeriesStat

Copies the value of SrvMonIntSeries into the provided value.

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

Specified by:

getIntSeriesTo in interface ISrvMonUserSeriesStat

Parameters:

to - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeIntSeries

public final SrvMonIntSeries takeIntSeries()

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

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

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

Specified by:

takeIntSeries in interface ISrvMonUserSeriesStat

Returns:

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

hasIntSeries

public final boolean hasIntSeries()

Description copied from interface: ISrvMonUserSeriesStat

Checks for the presence of 'intSeries'.

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

Specified by:

hasIntSeries in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.getIntSeries()

clearIntSeries

public final void clearIntSeries()

Description copied from interface: ISrvMonUserSeriesStat

Clears the value of 'intSeries'.

Field Description

The collected int series data for an INT series.

This field should only be set when the series type is set to SrvMonSeriesType.INT.

Specified by:

clearIntSeries in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.setIntSeries(SrvMonIntSeries)

getLongSeriesFieldId

public static final int getLongSeriesFieldId()

setLongSeries

public final void setLongSeries(SrvMonLongSeries val)

Description copied from interface: ISrvMonUserSeriesStat

Sets the value of 'longSeries'.

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

Specified by:

setLongSeries in interface ISrvMonUserSeriesStat

Parameters:

val - The value to set.

lendLongSeries

public final void lendLongSeries(SrvMonLongSeries val)

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

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:

lendLongSeries in interface ISrvMonUserSeriesStat

Parameters:

val - the value to 'lend' to lend.

getLongSeries

public final SrvMonLongSeries getLongSeries()

Description copied from interface: ISrvMonUserSeriesStat

Gets the value of 'longSeries'.

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

Specified by:

getLongSeries in interface ISrvMonUserSeriesStat

Returns:

The collected long series data for an LONG series.

getLongSeriesTo

public final void getLongSeriesTo(SrvMonLongSeries to)

Description copied from interface: ISrvMonUserSeriesStat

Copies the value of SrvMonLongSeries into the provided value.

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

Specified by:

getLongSeriesTo in interface ISrvMonUserSeriesStat

Parameters:

to - the value to copy into

See Also:

SrvMonLongSeries.copyInto(SrvMonLongSeries)

takeLongSeries

public final SrvMonLongSeries takeLongSeries()

Description copied from interface: ISrvMonUserSeriesStat

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

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

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

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

Specified by:

takeLongSeries in interface ISrvMonUserSeriesStat

Returns:

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

hasLongSeries

public final boolean hasLongSeries()

Description copied from interface: ISrvMonUserSeriesStat

Checks for the presence of 'longSeries'.

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

Specified by:

hasLongSeries in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.getLongSeries()

clearLongSeries

public final void clearLongSeries()

Description copied from interface: ISrvMonUserSeriesStat

Clears the value of 'longSeries'.

Field Description

The collected long series data for an LONG series.

This field should only be set when the series type is set to SrvMonSeriesType.LONG.

Specified by:

clearLongSeries in interface ISrvMonUserSeriesStat

See Also:

ISrvMonUserSeriesStat.setLongSeries(SrvMonLongSeries)

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonUserSeriesStat deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonUserSeriesStat deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

sync

public final void sync()

desync

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

Description copied from interface: com.neeve.xbuf.IXbufDesyncer

Desync fields from a buffer

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

Parameters:

buffer - The buffer to desync from

pos - The position in the container's backing buffer to desync from

frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information

init

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonUserSeriesStat> 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<T>)

Specified by:

getPool in interface UtlPool.Item<SrvMonUserSeriesStat>

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonUserSeriesStat 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 SrvMonUserSeriesStat copy()

Creates a copy of this SrvMonUserSeriesStat.

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

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

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

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