com.neeve.server.mon
Class SrvMonUserGaugeStat

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

All Implemented Interfaces:

IRogValidatable, ISrvMonUserGaugeStat, UtlPool.Item<SrvMonUserGaugeStat>, 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=221)
public final class SrvMonUserGaugeStat
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonUserGaugeStat>, ISrvMonUserGaugeStat

An application defined gauge statistic. A gauge represents a value at the time of a statistics collection.

The value for a Gauge is based on the value of its gaugeType. The gaugeType should be examined to determine which getXXXValue method to call.

Nested Class Summary

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

Field Summary

static SrvMonUserGaugeStat[]

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

Constructor Summary

SrvMonUserGaugeStat()

SrvMonUserGaugeStat(int initialBackingBufferSize)

Method Summary

SrvMonUserGaugeStat	acquire()
void	clearBooleanValue() Clears the value of 'booleanValue' Field Description The value for a BOOLEAN gauge
void	clearByteValue() Clears the value of 'byteValue' Field Description The value for a BYTE gauge
void	clearCharValue() Clears the value of 'charValue' Field Description The value for a CHAR gauge
void	clearContent()
void	clearDoubleValue() Clears the value of 'doubleValue' Field Description The value for a DOUBLE gauge
void	clearFloatValue() Clears the value of 'floatValue' Field Description The value for a FLOAT gauge
void	clearGuageType() Clears the value of 'guageType' Field Description The name of the gauge value
void	clearIntValue() Clears the value of 'intValue' Field Description The value for a INT gauge
void	clearLongValue() Clears the value of 'longValue' Field Description The value for a LONG gauge
void	clearName() Clears the value of 'name' Field Description The name of the gauge statistic
void	clearShortValue() Clears the value of 'shortValue' Field Description The value for a SHORT gauge
void	clearStringValue() Clears the value of 'stringValue' Field Description The value for a STRING gauge
void	clearXRogType()
Object	clone() Creates a clone of this object.
SrvMonUserGaugeStat	copy() Creates a copy of this SrvMonUserGaugeStat.
void	copyInto(SrvMonUserGaugeStat copy) Copies the contents of this SrvMonUserGaugeStat into the target.
static SrvMonUserGaugeStat	create()
static SrvMonUserGaugeStat	createFrom(byte[] serializedContainer)
static SrvMonUserGaugeStat	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonUserGaugeStat	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonUserGaugeStat	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonUserGaugeStat	deserializeFromByteArray(byte[] array)
SrvMonUserGaugeStat	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserGaugeStat	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonUserGaugeStat	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserGaugeStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonUserGaugeStat	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonUserGaugeStat	deserializeFromNative(long address, int offset, int length)
SrvMonUserGaugeStat	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()
boolean	getBooleanValue() Gets the value of 'booleanValue' Field Description The value for a BOOLEAN gauge
com.neeve.xbuf.XbufVariableBooleanField	getBooleanValueField()
static int	getBooleanValueFieldId() Get the field id for 'booleanValue' This method can be used to set field interests.
byte	getByteValue() Gets the value of 'byteValue' Field Description The value for a BYTE gauge
com.neeve.xbuf.XbufVariableByteField	getByteValueField()
static int	getByteValueFieldId() Get the field id for 'byteValue' This method can be used to set field interests.
char	getCharValue() Gets the value of 'charValue' Field Description The value for a CHAR gauge
com.neeve.xbuf.XbufVariableCharField	getCharValueField()
static int	getCharValueFieldId() Get the field id for 'charValue' This method can be used to set field interests.
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
double	getDoubleValue() Gets the value of 'doubleValue' Field Description The value for a DOUBLE gauge
com.neeve.xbuf.XbufDoubleField	getDoubleValueField()
static int	getDoubleValueFieldId() Get the field id for 'doubleValue' This method can be used to set field interests.
float	getFloatValue() Gets the value of 'floatValue' Field Description The value for a FLOAT gauge
com.neeve.xbuf.XbufFloatField	getFloatValueField()
static int	getFloatValueFieldId() Get the field id for 'floatValue' This method can be used to set field interests.
SrvMonGaugeType	getGuageType() Gets the value of 'guageType' Field Description The name of the gauge value
com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType>	getGuageTypeField()
static int	getGuageTypeFieldId() Get the field id for 'guageType' This method can be used to set field interests.
int	getIntValue() Gets the value of 'intValue' Field Description The value for a INT gauge
com.neeve.xbuf.XbufVariableIntField	getIntValueField()
static int	getIntValueFieldId() Get the field id for 'intValue' This method can be used to set field interests.
boolean	getIsReadOnly()
long	getLongValue() Gets the value of 'longValue' Field Description The value for a LONG gauge
com.neeve.xbuf.XbufVariableLongField	getLongValueField()
static int	getLongValueFieldId() Get the field id for 'longValue' This method can be used to set field interests.
String	getName() Gets the value of 'name' Field Description The name of the gauge statistic
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<SrvMonUserGaugeStat>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
short	getShortValue() Gets the value of 'shortValue' Field Description The value for a SHORT gauge
com.neeve.xbuf.XbufVariableShortField	getShortValueField()
static int	getShortValueFieldId() Get the field id for 'shortValue' This method can be used to set field interests.
String	getStringValue() Gets the value of 'stringValue' Field Description The value for a STRING gauge
com.neeve.xbuf.XbufStringField	getStringValueField()
static int	getStringValueFieldId() Get the field id for 'stringValue' This method can be used to set field interests.
<T extends XString> T	getStringValueTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStringValueTo(XString val) Copies the value of 'stringValue' into the provided XString.
XString	getStringValueUnsafe() Gets the raw value of 'stringValue'.
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	hasBooleanValue() Checks for the presence of 'booleanValue' Field Description The value for a BOOLEAN gauge
boolean	hasByteValue() Checks for the presence of 'byteValue' Field Description The value for a BYTE gauge
boolean	hasCharValue() Checks for the presence of 'charValue' Field Description The value for a CHAR gauge
boolean	hasDoubleValue() Checks for the presence of 'doubleValue' Field Description The value for a DOUBLE gauge
boolean	hasFloatValue() Checks for the presence of 'floatValue' Field Description The value for a FLOAT gauge
boolean	hasGuageType() Checks for the presence of 'guageType' Field Description The name of the gauge value
boolean	hasIntValue() Checks for the presence of 'intValue' Field Description The value for a INT gauge
boolean	hasLongValue() Checks for the presence of 'longValue' Field Description The value for a LONG gauge
boolean	hasName() Checks for the presence of 'name' Field Description The name of the gauge statistic
boolean	hasShortValue() Checks for the presence of 'shortValue' Field Description The value for a SHORT gauge
boolean	hasStringValue() Checks for the presence of 'stringValue' Field Description The value for a STRING gauge
boolean	hasXRogType()
SrvMonUserGaugeStat	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendName(XString val) Sets the value of 'name' Field Description The name of the gauge statistic
void	lendStringValue(XString val) Sets the value of 'stringValue' Field Description The value for a STRING gauge
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	setBooleanValue(boolean val) Sets the value of 'booleanValue' Field Description The value for a BOOLEAN gauge
void	setBooleanValueFrom(com.neeve.xbuf.XbufVariableBooleanField val)
void	setByteValue(byte val) Sets the value of 'byteValue' Field Description The value for a BYTE gauge
void	setByteValueFrom(com.neeve.xbuf.XbufVariableByteField val)
void	setCharValue(char val) Sets the value of 'charValue' Field Description The value for a CHAR gauge
void	setCharValueFrom(com.neeve.xbuf.XbufVariableCharField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
void	setDoubleValue(double val) Sets the value of 'doubleValue' Field Description The value for a DOUBLE gauge
void	setDoubleValueFrom(com.neeve.xbuf.XbufDoubleField val)
static void	setFieldInterest(List<Integer> fieldIds)
void	setFloatValue(float val) Sets the value of 'floatValue' Field Description The value for a FLOAT gauge
void	setFloatValueFrom(com.neeve.xbuf.XbufFloatField val)
void	setGuageType(SrvMonGaugeType val) Sets the value of 'guageType' Field Description The name of the gauge value
void	setGuageTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> val)
void	setIntValue(int val) Sets the value of 'intValue' Field Description The value for a INT gauge
void	setIntValueFrom(com.neeve.xbuf.XbufVariableIntField val)
void	setLongValue(long val) Sets the value of 'longValue' Field Description The value for a LONG gauge
void	setLongValueFrom(com.neeve.xbuf.XbufVariableLongField val)
void	setName(String val) Sets the value of 'name' Field Description The name of the gauge statistic
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'.
SrvMonUserGaugeStat	setPool(UtlPool<SrvMonUserGaugeStat> pool) Set a pool item's pool.
void	setShortValue(short val) Sets the value of 'shortValue' Field Description The value for a SHORT gauge
void	setShortValueFrom(com.neeve.xbuf.XbufVariableShortField val)
void	setStringValue(String val) Sets the value of 'stringValue' Field Description The value for a STRING gauge
void	setStringValueFrom(long val) Sets the value of this String field to the given numeric value.
void	setStringValueFrom(com.neeve.xbuf.XbufStringField val)
void	setStringValueFrom(XString val) Copies the provided XString value into this object's 'stringValue'.
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 SrvMonUserGaugeStat[] EMPTY_ARRAY

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

Constructor Detail

SrvMonUserGaugeStat

public SrvMonUserGaugeStat()

SrvMonUserGaugeStat

public SrvMonUserGaugeStat(int initialBackingBufferSize)

Method Detail

create

public static SrvMonUserGaugeStat create()

createFromSerializedXbufContainer

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

createFromSerializedXbufContainer

public static SrvMonUserGaugeStat createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

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

createFrom

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

getGuageTypeFieldId

public static final int getGuageTypeFieldId()

Get the field id for 'guageType'

This method can be used to set field interests.

See Also:

getGuageType()

setGuageType

public final void setGuageType(SrvMonGaugeType val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'guageType'

Field Description

The name of the gauge value

Specified by:

setGuageType in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

setGuageTypeFrom

public final void setGuageTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> val)

getGuageTypeField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> getGuageTypeField()

getGuageType

public final SrvMonGaugeType getGuageType()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'guageType'

Field Description

The name of the gauge value

Specified by:

getGuageType in interface ISrvMonUserGaugeStat

Returns:

The name of the gauge value

hasGuageType

public final boolean hasGuageType()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'guageType'

Field Description

The name of the gauge value

Specified by:

hasGuageType in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getGuageType()

clearGuageType

public final void clearGuageType()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'guageType'

Field Description

The name of the gauge value

Specified by:

clearGuageType in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setGuageType(SrvMonGaugeType)

getBooleanValueFieldId

public static final int getBooleanValueFieldId()

Get the field id for 'booleanValue'

This method can be used to set field interests.

See Also:

getBooleanValue()

setBooleanValue

public final void setBooleanValue(boolean val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'booleanValue'

Field Description

The value for a BOOLEAN gauge

Specified by:

setBooleanValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getBooleanValue

public final boolean getBooleanValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'booleanValue'

Field Description

The value for a BOOLEAN gauge

Specified by:

getBooleanValue in interface ISrvMonUserGaugeStat

Returns:

The value for a BOOLEAN gauge

setBooleanValueFrom

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

getBooleanValueField

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

hasBooleanValue

public final boolean hasBooleanValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'booleanValue'

Field Description

The value for a BOOLEAN gauge

Specified by:

hasBooleanValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getBooleanValue()

clearBooleanValue

public final void clearBooleanValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'booleanValue'

Field Description

The value for a BOOLEAN gauge

Specified by:

clearBooleanValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setBooleanValue(boolean)

getByteValueFieldId

public static final int getByteValueFieldId()

Get the field id for 'byteValue'

This method can be used to set field interests.

See Also:

getByteValue()

setByteValue

public final void setByteValue(byte val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'byteValue'

Field Description

The value for a BYTE gauge

Specified by:

setByteValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getByteValue

public final byte getByteValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'byteValue'

Field Description

The value for a BYTE gauge

Specified by:

getByteValue in interface ISrvMonUserGaugeStat

Returns:

The value for a BYTE gauge

setByteValueFrom

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

getByteValueField

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

hasByteValue

public final boolean hasByteValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'byteValue'

Field Description

The value for a BYTE gauge

Specified by:

hasByteValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getByteValue()

clearByteValue

public final void clearByteValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'byteValue'

Field Description

The value for a BYTE gauge

Specified by:

clearByteValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setByteValue(byte)

getCharValueFieldId

public static final int getCharValueFieldId()

Get the field id for 'charValue'

This method can be used to set field interests.

See Also:

getCharValue()

setCharValue

public final void setCharValue(char val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'charValue'

Field Description

The value for a CHAR gauge

Specified by:

setCharValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getCharValue

public final char getCharValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'charValue'

Field Description

The value for a CHAR gauge

Specified by:

getCharValue in interface ISrvMonUserGaugeStat

Returns:

The value for a CHAR gauge

setCharValueFrom

public final void setCharValueFrom(com.neeve.xbuf.XbufVariableCharField val)

getCharValueField

public final com.neeve.xbuf.XbufVariableCharField getCharValueField()

hasCharValue

public final boolean hasCharValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'charValue'

Field Description

The value for a CHAR gauge

Specified by:

hasCharValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getCharValue()

clearCharValue

public final void clearCharValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'charValue'

Field Description

The value for a CHAR gauge

Specified by:

clearCharValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setCharValue(char)

getShortValueFieldId

public static final int getShortValueFieldId()

Get the field id for 'shortValue'

This method can be used to set field interests.

See Also:

getShortValue()

setShortValue

public final void setShortValue(short val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'shortValue'

Field Description

The value for a SHORT gauge

Specified by:

setShortValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getShortValue

public final short getShortValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'shortValue'

Field Description

The value for a SHORT gauge

Specified by:

getShortValue in interface ISrvMonUserGaugeStat

Returns:

The value for a SHORT gauge

setShortValueFrom

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

getShortValueField

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

hasShortValue

public final boolean hasShortValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'shortValue'

Field Description

The value for a SHORT gauge

Specified by:

hasShortValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getShortValue()

clearShortValue

public final void clearShortValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'shortValue'

Field Description

The value for a SHORT gauge

Specified by:

clearShortValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setShortValue(short)

getIntValueFieldId

public static final int getIntValueFieldId()

Get the field id for 'intValue'

This method can be used to set field interests.

See Also:

getIntValue()

setIntValue

public final void setIntValue(int val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'intValue'

Field Description

The value for a INT gauge

Specified by:

setIntValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getIntValue

public final int getIntValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'intValue'

Field Description

The value for a INT gauge

Specified by:

getIntValue in interface ISrvMonUserGaugeStat

Returns:

The value for a INT gauge

setIntValueFrom

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

getIntValueField

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

hasIntValue

public final boolean hasIntValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'intValue'

Field Description

The value for a INT gauge

Specified by:

hasIntValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getIntValue()

clearIntValue

public final void clearIntValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'intValue'

Field Description

The value for a INT gauge

Specified by:

clearIntValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setIntValue(int)

getLongValueFieldId

public static final int getLongValueFieldId()

Get the field id for 'longValue'

This method can be used to set field interests.

See Also:

getLongValue()

setLongValue

public final void setLongValue(long val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'longValue'

Field Description

The value for a LONG gauge

Specified by:

setLongValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getLongValue

public final long getLongValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'longValue'

Field Description

The value for a LONG gauge

Specified by:

getLongValue in interface ISrvMonUserGaugeStat

Returns:

The value for a LONG gauge

setLongValueFrom

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

getLongValueField

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

hasLongValue

public final boolean hasLongValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'longValue'

Field Description

The value for a LONG gauge

Specified by:

hasLongValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getLongValue()

clearLongValue

public final void clearLongValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'longValue'

Field Description

The value for a LONG gauge

Specified by:

clearLongValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setLongValue(long)

getFloatValueFieldId

public static final int getFloatValueFieldId()

Get the field id for 'floatValue'

This method can be used to set field interests.

See Also:

getFloatValue()

setFloatValue

public final void setFloatValue(float val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'floatValue'

Field Description

The value for a FLOAT gauge

Specified by:

setFloatValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getFloatValue

public final float getFloatValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'floatValue'

Field Description

The value for a FLOAT gauge

Specified by:

getFloatValue in interface ISrvMonUserGaugeStat

Returns:

The value for a FLOAT gauge

setFloatValueFrom

public final void setFloatValueFrom(com.neeve.xbuf.XbufFloatField val)

getFloatValueField

public final com.neeve.xbuf.XbufFloatField getFloatValueField()

hasFloatValue

public final boolean hasFloatValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'floatValue'

Field Description

The value for a FLOAT gauge

Specified by:

hasFloatValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getFloatValue()

clearFloatValue

public final void clearFloatValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'floatValue'

Field Description

The value for a FLOAT gauge

Specified by:

clearFloatValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setFloatValue(float)

getDoubleValueFieldId

public static final int getDoubleValueFieldId()

Get the field id for 'doubleValue'

This method can be used to set field interests.

See Also:

getDoubleValue()

setDoubleValue

public final void setDoubleValue(double val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'doubleValue'

Field Description

The value for a DOUBLE gauge

Specified by:

setDoubleValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getDoubleValue

public final double getDoubleValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'doubleValue'

Field Description

The value for a DOUBLE gauge

Specified by:

getDoubleValue in interface ISrvMonUserGaugeStat

Returns:

The value for a DOUBLE gauge

setDoubleValueFrom

public final void setDoubleValueFrom(com.neeve.xbuf.XbufDoubleField val)

getDoubleValueField

public final com.neeve.xbuf.XbufDoubleField getDoubleValueField()

hasDoubleValue

public final boolean hasDoubleValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'doubleValue'

Field Description

The value for a DOUBLE gauge

Specified by:

hasDoubleValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getDoubleValue()

clearDoubleValue

public final void clearDoubleValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'doubleValue'

Field Description

The value for a DOUBLE gauge

Specified by:

clearDoubleValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setDoubleValue(double)

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

Sets the value of 'name'

Field Description

The name of the gauge statistic

Specified by:

setName in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getName

public final String getName()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'name'

Field Description

The name of the gauge statistic

Specified by:

getName in interface ISrvMonUserGaugeStat

Returns:

The name of the gauge statistic

lendName

public final void lendName(XString val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'name'

Field Description

The name of the gauge statistic

Specified by:

lendName in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

setNameFrom

public final void setNameFrom(long val)

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The name of the gauge statistic

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

getNameTo

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

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The name of the gauge 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 ISrvMonUserGaugeStat

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

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

Field Description

The name of the gauge statistic

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

Specified by:

setNameFrom in interface ISrvMonUserGaugeStat

getNameTo

public final void getNameTo(XString val)

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The name of the gauge statistic

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

Specified by:

getNameTo in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getName()

getNameUnsafe

public final XString getNameUnsafe()

Description copied from interface: ISrvMonUserGaugeStat

Gets the raw value of 'name'.

Field Description

The name of the gauge 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 ISrvMonUserGaugeStat

Returns:

the field's raw value

See Also:

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

Checks for the presence of 'name'

Field Description

The name of the gauge statistic

Specified by:

hasName in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getName()

clearName

public final void clearName()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'name'

Field Description

The name of the gauge statistic

Specified by:

clearName in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.setName(String)

getStringValueFieldId

public static final int getStringValueFieldId()

Get the field id for 'stringValue'

This method can be used to set field interests.

See Also:

getStringValue()

setStringValue

public final void setStringValue(String val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'stringValue'

Field Description

The value for a STRING gauge

Specified by:

setStringValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

getStringValue

public final String getStringValue()

Description copied from interface: ISrvMonUserGaugeStat

Gets the value of 'stringValue'

Field Description

The value for a STRING gauge

Specified by:

getStringValue in interface ISrvMonUserGaugeStat

Returns:

The value for a STRING gauge

lendStringValue

public final void lendStringValue(XString val)

Description copied from interface: ISrvMonUserGaugeStat

Sets the value of 'stringValue'

Field Description

The value for a STRING gauge

Specified by:

lendStringValue in interface ISrvMonUserGaugeStat

Parameters:

val - The value to set.

setStringValueFrom

public final void setStringValueFrom(long val)

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The value for a STRING gauge

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

Specified by:

setStringValueFrom in interface ISrvMonUserGaugeStat

getStringValueTo

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

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The value for a STRING gauge

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:

getStringValueTo in interface ISrvMonUserGaugeStat

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.

setStringValueFrom

public final void setStringValueFrom(XString val)

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The value for a STRING gauge

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

Specified by:

setStringValueFrom in interface ISrvMonUserGaugeStat

getStringValueTo

public final void getStringValueTo(XString val)

Description copied from interface: ISrvMonUserGaugeStat

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

Field Description

The value for a STRING gauge

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

Specified by:

getStringValueTo in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getStringValue()

getStringValueUnsafe

public final XString getStringValueUnsafe()

Description copied from interface: ISrvMonUserGaugeStat

Gets the raw value of 'stringValue'.

Field Description

The value for a STRING gauge

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:

getStringValueUnsafe in interface ISrvMonUserGaugeStat

Returns:

the field's raw value

See Also:

ISrvMonUserGaugeStat.getStringValue()

setStringValueFrom

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

getStringValueField

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

hasStringValue

public final boolean hasStringValue()

Description copied from interface: ISrvMonUserGaugeStat

Checks for the presence of 'stringValue'

Field Description

The value for a STRING gauge

Specified by:

hasStringValue in interface ISrvMonUserGaugeStat

See Also:

ISrvMonUserGaugeStat.getStringValue()

clearStringValue

public final void clearStringValue()

Description copied from interface: ISrvMonUserGaugeStat

Clears the value of 'stringValue'

Field Description

The value for a STRING gauge

Specified by:

clearStringValue in interface ISrvMonUserGaugeStat

See Also:

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

deserializeFromIOElasticBuffer

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

deserializeFromByteArray

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

deserializeFromByteArray

public final SrvMonUserGaugeStat deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

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

deserializeFromByteBuffer

public final SrvMonUserGaugeStat deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

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

deserializeFromNative

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

Returns:

Return 'this' object for method invocation chaining.

setPool

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

Returns:

Return 'this' object for method invocation chaining.

getPool

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

Returns:

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

isReferenceCounted

public final boolean isReferenceCounted()

acquire

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

Creates a copy of this SrvMonUserGaugeStat.

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

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

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

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