com.neeve.server.mon

Interface ISrvMonUserGaugeStat

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonUserGaugeStat

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(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)")
public interface ISrvMonUserGaugeStat
extends IRogValidatable

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.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
booleanValue	Boolean	3	The value for a BOOLEAN gauge.
byteValue	Byte	4	The value for a BYTE gauge.
charValue	Char	5	The value for a CHAR gauge.
doubleValue	Double	10	The value for a DOUBLE gauge.
floatValue	Float	9	The value for a FLOAT gauge.
guageType	SrvMonGaugeType	2	The name of the gauge value.
intValue	Integer	7	The value for a INT gauge.
longValue	Long	8	The value for a LONG gauge.
name	String	1	The name of the gauge statistic.
shortValue	Short	6	The value for a SHORT gauge.
stringValue	String	11	The value for a STRING gauge.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearBooleanValue() Clears the value of 'booleanValue'.
void	clearByteValue() Clears the value of 'byteValue'.
void	clearCharValue() Clears the value of 'charValue'.
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'.
boolean	getBooleanValue() Gets the value of 'booleanValue'.
byte	getByteValue() Gets the value of 'byteValue'.
char	getCharValue() Gets the value of 'charValue'.
double	getDoubleValue() Gets the value of 'doubleValue'.
float	getFloatValue() Gets the value of 'floatValue'.
SrvMonGaugeType	getGuageType() Gets the value of 'guageType'.
int	getIntValue() Gets the value of 'intValue'.
long	getLongValue() Gets the value of 'longValue'.
String	getName() Gets the value of 'name'.
<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'.
short	getShortValue() Gets the value of 'shortValue'.
String	getStringValue() Gets the value of 'stringValue'.
<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'.
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'.
void	lendName(XString val) Lends the value of 'name' to this object.
void	lendStringValue(XString val) Lends the value of 'stringValue' to this object.
void	setBooleanValue(boolean val) Sets the value of 'booleanValue'.
void	setByteValue(byte val) Sets the value of 'byteValue'.
void	setCharValue(char val) Sets the value of 'charValue'.
void	setDoubleValue(double val) Sets the value of 'doubleValue'.
void	setFloatValue(float val) Sets the value of 'floatValue'.
void	setGuageType(SrvMonGaugeType val) Sets the value of 'guageType'.
void	setIntValue(int val) Sets the value of 'intValue'.
void	setLongValue(long val) Sets the value of 'longValue'.
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(XString val) Copies the provided XString value into this object's 'name'.
void	setShortValue(short val) Sets the value of 'shortValue'.
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(XString val) Copies the provided XString value into this object's 'stringValue'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setGuageType

void setGuageType(SrvMonGaugeType val)

Sets the value of 'guageType'.

Field Description

The name of the gauge value.

Parameters:

val - The value to set.

getGuageType

SrvMonGaugeType getGuageType()

Gets the value of 'guageType'.

Field Description

The name of the gauge value.

Returns:

The name of the gauge value.

clearGuageType

void clearGuageType()

Clears the value of 'guageType'.

Field Description

The name of the gauge value.

See Also:

setGuageType(SrvMonGaugeType)

hasGuageType

boolean hasGuageType()

Checks for the presence of 'guageType'.

Field Description

The name of the gauge value.

See Also:

getGuageType()

setBooleanValue

void setBooleanValue(boolean val)

Sets the value of 'booleanValue'.

Field Description

The value for a BOOLEAN gauge.

Parameters:

val - The value to set.

getBooleanValue

boolean getBooleanValue()

Gets the value of 'booleanValue'.

Field Description

The value for a BOOLEAN gauge.

Returns:

The value for a BOOLEAN gauge.

clearBooleanValue

void clearBooleanValue()

Clears the value of 'booleanValue'.

Field Description

The value for a BOOLEAN gauge.

See Also:

setBooleanValue(boolean)

hasBooleanValue

boolean hasBooleanValue()

Checks for the presence of 'booleanValue'.

Field Description

The value for a BOOLEAN gauge.

See Also:

getBooleanValue()

setByteValue

void setByteValue(byte val)

Sets the value of 'byteValue'.

Field Description

The value for a BYTE gauge.

Parameters:

val - The value to set.

getByteValue

byte getByteValue()

Gets the value of 'byteValue'.

Field Description

The value for a BYTE gauge.

Returns:

The value for a BYTE gauge.

clearByteValue

void clearByteValue()

Clears the value of 'byteValue'.

Field Description

The value for a BYTE gauge.

See Also:

setByteValue(byte)

hasByteValue

boolean hasByteValue()

Checks for the presence of 'byteValue'.

Field Description

The value for a BYTE gauge.

See Also:

getByteValue()

setCharValue

void setCharValue(char val)

Sets the value of 'charValue'.

Field Description

The value for a CHAR gauge.

Parameters:

val - The value to set.

getCharValue

char getCharValue()

Gets the value of 'charValue'.

Field Description

The value for a CHAR gauge.

Returns:

The value for a CHAR gauge.

clearCharValue

void clearCharValue()

Clears the value of 'charValue'.

Field Description

The value for a CHAR gauge.

See Also:

setCharValue(char)

hasCharValue

boolean hasCharValue()

Checks for the presence of 'charValue'.

Field Description

The value for a CHAR gauge.

See Also:

getCharValue()

setShortValue

void setShortValue(short val)

Sets the value of 'shortValue'.

Field Description

The value for a SHORT gauge.

Parameters:

val - The value to set.

getShortValue

short getShortValue()

Gets the value of 'shortValue'.

Field Description

The value for a SHORT gauge.

Returns:

The value for a SHORT gauge.

clearShortValue

void clearShortValue()

Clears the value of 'shortValue'.

Field Description

The value for a SHORT gauge.

See Also:

setShortValue(short)

hasShortValue

boolean hasShortValue()

Checks for the presence of 'shortValue'.

Field Description

The value for a SHORT gauge.

See Also:

getShortValue()

setIntValue

void setIntValue(int val)

Sets the value of 'intValue'.

Field Description

The value for a INT gauge.

Parameters:

val - The value to set.

getIntValue

int getIntValue()

Gets the value of 'intValue'.

Field Description

The value for a INT gauge.

Returns:

The value for a INT gauge.

clearIntValue

void clearIntValue()

Clears the value of 'intValue'.

Field Description

The value for a INT gauge.

See Also:

setIntValue(int)

hasIntValue

boolean hasIntValue()

Checks for the presence of 'intValue'.

Field Description

The value for a INT gauge.

See Also:

getIntValue()

setLongValue

void setLongValue(long val)

Sets the value of 'longValue'.

Field Description

The value for a LONG gauge.

Parameters:

val - The value to set.

getLongValue

long getLongValue()

Gets the value of 'longValue'.

Field Description

The value for a LONG gauge.

Returns:

The value for a LONG gauge.

clearLongValue

void clearLongValue()

Clears the value of 'longValue'.

Field Description

The value for a LONG gauge.

See Also:

setLongValue(long)

hasLongValue

boolean hasLongValue()

Checks for the presence of 'longValue'.

Field Description

The value for a LONG gauge.

See Also:

getLongValue()

setFloatValue

void setFloatValue(float val)

Sets the value of 'floatValue'.

Field Description

The value for a FLOAT gauge.

Parameters:

val - The value to set.

getFloatValue

float getFloatValue()

Gets the value of 'floatValue'.

Field Description

The value for a FLOAT gauge.

Returns:

The value for a FLOAT gauge.

clearFloatValue

void clearFloatValue()

Clears the value of 'floatValue'.

Field Description

The value for a FLOAT gauge.

See Also:

setFloatValue(float)

hasFloatValue

boolean hasFloatValue()

Checks for the presence of 'floatValue'.

Field Description

The value for a FLOAT gauge.

See Also:

getFloatValue()

setDoubleValue

void setDoubleValue(double val)

Sets the value of 'doubleValue'.

Field Description

The value for a DOUBLE gauge.

Parameters:

val - The value to set.

getDoubleValue

double getDoubleValue()

Gets the value of 'doubleValue'.

Field Description

The value for a DOUBLE gauge.

Returns:

The value for a DOUBLE gauge.

clearDoubleValue

void clearDoubleValue()

Clears the value of 'doubleValue'.

Field Description

The value for a DOUBLE gauge.

See Also:

setDoubleValue(double)

hasDoubleValue

boolean hasDoubleValue()

Checks for the presence of 'doubleValue'.

Field Description

The value for a DOUBLE gauge.

See Also:

getDoubleValue()

setName

void setName(String val)

Sets the value of 'name'.

Field Description

The name of the gauge statistic.

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'.

Field Description

The name of the gauge statistic.

Returns:

The name of the gauge statistic.

lendName

void lendName(XString val)

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 gauge 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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setNameFrom

void setNameFrom(long val)

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 setName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getNameTo

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

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;

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.

Throws:

NullPointerException - if the provided factory is null

setNameFrom

void setNameFrom(XString val)

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 setName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getNameTo

void getNameTo(XString val)

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 getName() bec because it can avoid decoding the value into an String.

See Also:

getName()

getNameUnsafe

XString getNameUnsafe()

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.

Returns:

the field's raw value

See Also:

getName()

clearName

void clearName()

Clears the value of 'name'.

Field Description

The name of the gauge statistic.

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'.

Field Description

The name of the gauge statistic.

See Also:

getName()

setStringValue

void setStringValue(String val)

Sets the value of 'stringValue'.

Field Description

The value for a STRING gauge.

Parameters:

val - The value to set.

getStringValue

String getStringValue()

Gets the value of 'stringValue'.

Field Description

The value for a STRING gauge.

Returns:

The value for a STRING gauge.

lendStringValue

void lendStringValue(XString val)

Lends the value of 'stringValue' to this object.

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.

Field Description

The value for a STRING gauge.

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.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setStringValueFrom

void setStringValueFrom(long val)

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 setStringValue(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getStringValueTo

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

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;

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.

Throws:

NullPointerException - if the provided factory is null

setStringValueFrom

void setStringValueFrom(XString val)

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 setStringValue(String) because it avoids encoding the value into a String if the given XString is already encoded.

getStringValueTo

void getStringValueTo(XString val)

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 getStringValue() bec because it can avoid decoding the value into an String.

See Also:

getStringValue()

getStringValueUnsafe

XString getStringValueUnsafe()

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.

Returns:

the field's raw value

See Also:

getStringValue()

clearStringValue

void clearStringValue()

Clears the value of 'stringValue'.

Field Description

The value for a STRING gauge.

See Also:

setStringValue(String)

hasStringValue

boolean hasStringValue()

Checks for the presence of 'stringValue'.

Field Description

The value for a STRING gauge.

See Also:

getStringValue()