@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Thu May 07 15:37:32 EDT 2020") @AdmGenerated(encoding="Xbuf", compatLevel="4.0.0", admVersion="nvx-rumi-adm v3.14 (build 29)", date="5/7/20 3:37 PM", buildInfo="nvx-talon-3.14.19 (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
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.
ADM Type | Embedded Entity |
Factory | SrvMonFactory |
ADM Field Summary |
---|
Field | Type | Id | Description |
---|---|---|---|
booleanValue | Boolean | 18 | The value for a BOOLEAN gauge. |
byteValue | Byte | 19 | The value for a BYTE gauge. |
charValue | Char | 20 | The value for a CHAR gauge. |
doubleValue | Double | 25 | The value for a DOUBLE gauge. |
floatValue | Float | 24 | The value for a FLOAT gauge. |
guageType | SrvMonGaugeType |
17 | The name of the gauge value. |
intValue | Integer | 22 | The value for a INT gauge. |
longValue | Long | 23 | The value for a LONG gauge. |
name | String | 16 | The name of the gauge statistic. |
shortValue | Short | 21 | The value for a SHORT gauge. |
stringValue | String | 26 | The value for a STRING gauge. |
Modifier and Type | Class and Description |
---|---|
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).
|
Modifier and Type | Field and Description |
---|---|
static SrvMonUserGaugeStat[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
Constructor and Description |
---|
SrvMonUserGaugeStat() |
SrvMonUserGaugeStat(int initialBackingBufferSize) |
Modifier and Type | Method and Description |
---|---|
SrvMonUserGaugeStat |
acquire() |
void |
clearBooleanValue()
Clears the value of 'booleanValue'.
|
void |
clearByteValue()
Clears the value of 'byteValue'.
|
void |
clearCharValue()
Clears the value of 'charValue'.
|
void |
clearContent() |
void |
clearDoubleValue()
Clears the value of 'doubleValue'.
|
void |
clearFloatValue()
Clears the value of 'floatValue'.
|
void |
clearGuageType()
Clears the value of 'guageType'.
|
void |
clearIntValue()
Clears the value of 'intValue'.
|
void |
clearLongValue()
Clears the value of 'longValue'.
|
void |
clearName()
Clears the value of 'name'.
|
void |
clearShortValue()
Clears the value of 'shortValue'.
|
void |
clearStringValue()
Clears the value of 'stringValue'.
|
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)
Desync fields from a buffer
|
void |
desyncFieldBitmask() |
void |
dispose() |
PktBuffer |
getBackingBuffer() |
boolean |
getBooleanValue()
Gets the value of 'booleanValue'.
|
com.neeve.xbuf.XbufVariableBooleanField |
getBooleanValueField() |
static int |
getBooleanValueFieldId() |
byte |
getByteValue()
Gets the value of 'byteValue'.
|
com.neeve.xbuf.XbufVariableByteField |
getByteValueField() |
static int |
getByteValueFieldId() |
char |
getCharValue()
Gets the value of 'charValue'.
|
com.neeve.xbuf.XbufVariableCharField |
getCharValueField() |
static int |
getCharValueFieldId() |
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
double |
getDoubleValue()
Gets the value of 'doubleValue'.
|
com.neeve.xbuf.XbufDoubleField |
getDoubleValueField() |
static int |
getDoubleValueFieldId() |
float |
getFloatValue()
Gets the value of 'floatValue'.
|
com.neeve.xbuf.XbufFloatField |
getFloatValueField() |
static int |
getFloatValueFieldId() |
SrvMonGaugeType |
getGuageType()
Gets the value of 'guageType'.
|
com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> |
getGuageTypeField() |
static int |
getGuageTypeFieldId() |
int |
getIntValue()
Gets the value of 'intValue'.
|
com.neeve.xbuf.XbufVariableIntField |
getIntValueField() |
static int |
getIntValueFieldId() |
boolean |
getIsReadOnly() |
long |
getLongValue()
Gets the value of 'longValue'.
|
com.neeve.xbuf.XbufVariableLongField |
getLongValueField() |
static int |
getLongValueFieldId() |
String |
getName()
Gets the value of 'name'.
|
com.neeve.xbuf.XbufStringField |
getNameField() |
static int |
getNameFieldId() |
<T extends XString> |
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'.
|
com.neeve.xbuf.XbufVariableShortField |
getShortValueField() |
static int |
getShortValueFieldId() |
String |
getStringValue()
Gets the value of 'stringValue'.
|
com.neeve.xbuf.XbufStringField |
getStringValueField() |
static int |
getStringValueFieldId() |
<T extends XString> |
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() |
boolean |
hasBooleanValue()
Checks for the presence of 'booleanValue'.
|
boolean |
hasByteValue()
Checks for the presence of 'byteValue'.
|
boolean |
hasCharValue()
Checks for the presence of 'charValue'.
|
boolean |
hasDoubleValue()
Checks for the presence of 'doubleValue'.
|
boolean |
hasFloatValue()
Checks for the presence of 'floatValue'.
|
boolean |
hasGuageType()
Checks for the presence of 'guageType'.
|
boolean |
hasIntValue()
Checks for the presence of 'intValue'.
|
boolean |
hasLongValue()
Checks for the presence of 'longValue'.
|
boolean |
hasName()
Checks for the presence of 'name'.
|
boolean |
hasShortValue()
Checks for the presence of 'shortValue'.
|
boolean |
hasStringValue()
Checks for the presence of 'stringValue'.
|
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)
Lends the value of 'name' to this object.
|
void |
lendStringValue(XString val)
Lends the value of 'stringValue' 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() |
void |
setBooleanValue(boolean val)
Sets the value of 'booleanValue'.
|
void |
setBooleanValueFrom(com.neeve.xbuf.XbufVariableBooleanField val) |
void |
setByteValue(byte val)
Sets the value of 'byteValue'.
|
void |
setByteValueFrom(com.neeve.xbuf.XbufVariableByteField val) |
void |
setCharValue(char val)
Sets the value of 'charValue'.
|
void |
setCharValueFrom(com.neeve.xbuf.XbufVariableCharField val) |
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
void |
setDoubleValue(double val)
Sets the value of 'doubleValue'.
|
void |
setDoubleValueFrom(com.neeve.xbuf.XbufDoubleField val) |
static void |
setFieldInterest(List<Integer> fieldIds) |
void |
setFloatValue(float val)
Sets the value of 'floatValue'.
|
void |
setFloatValueFrom(com.neeve.xbuf.XbufFloatField val) |
void |
setGuageType(SrvMonGaugeType val)
Sets the value of 'guageType'.
|
void |
setGuageTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> val) |
void |
setIntValue(int val)
Sets the value of 'intValue'.
|
void |
setIntValueFrom(com.neeve.xbuf.XbufVariableIntField val) |
void |
setLongValue(long val)
Sets the value of 'longValue'.
|
void |
setLongValueFrom(com.neeve.xbuf.XbufVariableLongField val) |
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'.
|
SrvMonUserGaugeStat |
setPool(UtlPool<SrvMonUserGaugeStat> pool)
Set a pool item's pool.
|
void |
setPreserializedFields(PktBuffer buffer) |
void |
setShortValue(short val)
Sets the value of 'shortValue'.
|
void |
setShortValueFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
setStringValue(String val)
Sets the value of 'stringValue'.
|
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() |
public static final SrvMonUserGaugeStat[] EMPTY_ARRAY
public SrvMonUserGaugeStat()
public SrvMonUserGaugeStat(int initialBackingBufferSize)
public static SrvMonUserGaugeStat create()
public static SrvMonUserGaugeStat createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonUserGaugeStat createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonUserGaugeStat createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonUserGaugeStat createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final short getXRogType()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getGuageTypeFieldId()
public final void setGuageType(SrvMonGaugeType val)
ISrvMonUserGaugeStat
setGuageType
in interface ISrvMonUserGaugeStat
val
- The value to set.public final void setGuageTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonGaugeType> getGuageTypeField()
public final SrvMonGaugeType getGuageType()
ISrvMonUserGaugeStat
getGuageType
in interface ISrvMonUserGaugeStat
public final boolean hasGuageType()
ISrvMonUserGaugeStat
hasGuageType
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getGuageType()
public final void clearGuageType()
ISrvMonUserGaugeStat
clearGuageType
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setGuageType(SrvMonGaugeType)
public static final int getBooleanValueFieldId()
public final void setBooleanValue(boolean val)
ISrvMonUserGaugeStat
setBooleanValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final boolean getBooleanValue()
ISrvMonUserGaugeStat
getBooleanValue
in interface ISrvMonUserGaugeStat
public final void setBooleanValueFrom(com.neeve.xbuf.XbufVariableBooleanField val)
public final com.neeve.xbuf.XbufVariableBooleanField getBooleanValueField()
public final boolean hasBooleanValue()
ISrvMonUserGaugeStat
hasBooleanValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getBooleanValue()
public final void clearBooleanValue()
ISrvMonUserGaugeStat
clearBooleanValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setBooleanValue(boolean)
public static final int getByteValueFieldId()
public final void setByteValue(byte val)
ISrvMonUserGaugeStat
setByteValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final byte getByteValue()
ISrvMonUserGaugeStat
getByteValue
in interface ISrvMonUserGaugeStat
public final void setByteValueFrom(com.neeve.xbuf.XbufVariableByteField val)
public final com.neeve.xbuf.XbufVariableByteField getByteValueField()
public final boolean hasByteValue()
ISrvMonUserGaugeStat
hasByteValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getByteValue()
public final void clearByteValue()
ISrvMonUserGaugeStat
clearByteValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setByteValue(byte)
public static final int getCharValueFieldId()
public final void setCharValue(char val)
ISrvMonUserGaugeStat
setCharValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final char getCharValue()
ISrvMonUserGaugeStat
getCharValue
in interface ISrvMonUserGaugeStat
public final void setCharValueFrom(com.neeve.xbuf.XbufVariableCharField val)
public final com.neeve.xbuf.XbufVariableCharField getCharValueField()
public final boolean hasCharValue()
ISrvMonUserGaugeStat
hasCharValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getCharValue()
public final void clearCharValue()
ISrvMonUserGaugeStat
clearCharValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setCharValue(char)
public static final int getShortValueFieldId()
public final void setShortValue(short val)
ISrvMonUserGaugeStat
setShortValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final short getShortValue()
ISrvMonUserGaugeStat
getShortValue
in interface ISrvMonUserGaugeStat
public final void setShortValueFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getShortValueField()
public final boolean hasShortValue()
ISrvMonUserGaugeStat
hasShortValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getShortValue()
public final void clearShortValue()
ISrvMonUserGaugeStat
clearShortValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setShortValue(short)
public static final int getIntValueFieldId()
public final void setIntValue(int val)
ISrvMonUserGaugeStat
setIntValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final int getIntValue()
ISrvMonUserGaugeStat
getIntValue
in interface ISrvMonUserGaugeStat
public final void setIntValueFrom(com.neeve.xbuf.XbufVariableIntField val)
public final com.neeve.xbuf.XbufVariableIntField getIntValueField()
public final boolean hasIntValue()
ISrvMonUserGaugeStat
hasIntValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getIntValue()
public final void clearIntValue()
ISrvMonUserGaugeStat
clearIntValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setIntValue(int)
public static final int getLongValueFieldId()
public final void setLongValue(long val)
ISrvMonUserGaugeStat
setLongValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final long getLongValue()
ISrvMonUserGaugeStat
getLongValue
in interface ISrvMonUserGaugeStat
public final void setLongValueFrom(com.neeve.xbuf.XbufVariableLongField val)
public final com.neeve.xbuf.XbufVariableLongField getLongValueField()
public final boolean hasLongValue()
ISrvMonUserGaugeStat
hasLongValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getLongValue()
public final void clearLongValue()
ISrvMonUserGaugeStat
clearLongValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setLongValue(long)
public static final int getFloatValueFieldId()
public final void setFloatValue(float val)
ISrvMonUserGaugeStat
setFloatValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final float getFloatValue()
ISrvMonUserGaugeStat
getFloatValue
in interface ISrvMonUserGaugeStat
public final void setFloatValueFrom(com.neeve.xbuf.XbufFloatField val)
public final com.neeve.xbuf.XbufFloatField getFloatValueField()
public final boolean hasFloatValue()
ISrvMonUserGaugeStat
hasFloatValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getFloatValue()
public final void clearFloatValue()
ISrvMonUserGaugeStat
clearFloatValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setFloatValue(float)
public static final int getDoubleValueFieldId()
public final void setDoubleValue(double val)
ISrvMonUserGaugeStat
setDoubleValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final double getDoubleValue()
ISrvMonUserGaugeStat
getDoubleValue
in interface ISrvMonUserGaugeStat
public final void setDoubleValueFrom(com.neeve.xbuf.XbufDoubleField val)
public final com.neeve.xbuf.XbufDoubleField getDoubleValueField()
public final boolean hasDoubleValue()
ISrvMonUserGaugeStat
hasDoubleValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getDoubleValue()
public final void clearDoubleValue()
ISrvMonUserGaugeStat
clearDoubleValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setDoubleValue(double)
public static final int getNameFieldId()
public final void setName(String val)
ISrvMonUserGaugeStat
setName
in interface ISrvMonUserGaugeStat
val
- The value to set.public final String getName()
ISrvMonUserGaugeStat
getName
in interface ISrvMonUserGaugeStat
public final void lendName(XString val)
ISrvMonUserGaugeStat
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.
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.
lendName
in interface ISrvMonUserGaugeStat
val
- The value to set.public final void setNameFrom(long val)
ISrvMonUserGaugeStat
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.
setNameFrom
in interface ISrvMonUserGaugeStat
public final <T extends XString> T getNameTo(XString.Factory<T> factory)
ISrvMonUserGaugeStat
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;
getNameTo
in interface ISrvMonUserGaugeStat
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setNameFrom(XString val)
ISrvMonUserGaugeStat
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.
setNameFrom
in interface ISrvMonUserGaugeStat
public final void getNameTo(XString val)
ISrvMonUserGaugeStat
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
.
getNameTo
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getName()
public final XString getNameUnsafe()
ISrvMonUserGaugeStat
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.
getNameUnsafe
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getName()
public final void setNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getNameField()
public final boolean hasName()
ISrvMonUserGaugeStat
hasName
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getName()
public final void clearName()
ISrvMonUserGaugeStat
clearName
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setName(String)
public static final int getStringValueFieldId()
public final void setStringValue(String val)
ISrvMonUserGaugeStat
setStringValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final String getStringValue()
ISrvMonUserGaugeStat
getStringValue
in interface ISrvMonUserGaugeStat
public final void lendStringValue(XString val)
ISrvMonUserGaugeStat
This method is equivalent to setStringValue 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.
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.
lendStringValue
in interface ISrvMonUserGaugeStat
val
- The value to set.public final void setStringValueFrom(long val)
ISrvMonUserGaugeStat
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.
setStringValueFrom
in interface ISrvMonUserGaugeStat
public final <T extends XString> T getStringValueTo(XString.Factory<T> factory)
ISrvMonUserGaugeStat
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;
getStringValueTo
in interface ISrvMonUserGaugeStat
factory
- The factory from which to get the XString to copy into and returnnull
.public final void setStringValueFrom(XString val)
ISrvMonUserGaugeStat
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.
setStringValueFrom
in interface ISrvMonUserGaugeStat
public final void getStringValueTo(XString val)
ISrvMonUserGaugeStat
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
.
getStringValueTo
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getStringValue()
public final XString getStringValueUnsafe()
ISrvMonUserGaugeStat
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.
getStringValueUnsafe
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getStringValue()
public final void setStringValueFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getStringValueField()
public final boolean hasStringValue()
ISrvMonUserGaugeStat
hasStringValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.getStringValue()
public final void clearStringValue()
ISrvMonUserGaugeStat
clearStringValue
in interface ISrvMonUserGaugeStat
ISrvMonUserGaugeStat.setStringValue(String)
public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address, int addressOffset)
public final SrvMonUserGaugeStat deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserGaugeStat deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonUserGaugeStat deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserGaugeStat deserializeFromByteArray(byte[] array)
public final SrvMonUserGaugeStat deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserGaugeStat deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonUserGaugeStat deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserGaugeStat deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncer
desync
in interface com.neeve.xbuf.IXbufDesyncer
buffer
- The buffer to desync frompos
- The position in the container's backing buffer to desync
fromframeOnly
- Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean)
for more
informationpublic final SrvMonUserGaugeStat init()
UtlPool.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.
init
in interface UtlPool.Item<SrvMonUserGaugeStat>
public final SrvMonUserGaugeStat setPool(UtlPool<SrvMonUserGaugeStat> pool)
UtlPool.Item
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.
setPool
in interface UtlPool.Item<SrvMonUserGaugeStat>
public final UtlPool<SrvMonUserGaugeStat> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool
in interface UtlPool.Item<SrvMonUserGaugeStat>
UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
public final boolean isReferenceCounted()
public final SrvMonUserGaugeStat acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy()
method in that:
public final SrvMonUserGaugeStat copy()
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.
public final void copyInto(SrvMonUserGaugeStat copy)
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.
copy
- The target into which to copy.public final boolean isValid()
IRogValidatable
isValid
in interface IRogValidatable
public final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatable
getValidationErrors
in interface IRogValidatable
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.Copyright © 2019 Neeve Research, LLC. All Rights Reserved.