com.neeve.server.mon
Interface ISrvMonUserCounterStat

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonUserCounterStat

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(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)")
public interface ISrvMonUserCounterStat
extends IRogValidatable

An application defined counter statistic. A counter stat represents a monotonically increasing counter.

A Counter is useful for recording an increasing value over time. Sampled periodically it can be used to derive a rate. For example a counter could be used to record a number of message received. By sampling it over time it can be used to create a received message rate.

Method Summary

void	clearCount() Clears the value of 'count' Field Description The counter value
void	clearName() Clears the value of 'name' Field Description The name of the statistic
long	getCount() Gets the value of 'count' Field Description The counter value
String	getName() Gets the value of 'name' Field Description The name of the statistic
<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'.
boolean	hasCount() Checks for the presence of 'count' Field Description The counter value
boolean	hasName() Checks for the presence of 'name' Field Description The name of the statistic
void	lendName(XString val) Sets the value of 'name' Field Description The name of the statistic
void	setCount(long val) Sets the value of 'count' Field Description The counter value
void	setName(String val) Sets the value of 'name' Field Description The name of the statistic
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'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setCount

void setCount(long val)

Sets the value of 'count'

Field Description

The counter value

Parameters:

val - The value to set.

getCount

long getCount()

Gets the value of 'count'

Field Description

The counter value

Returns:

The counter value

clearCount

void clearCount()

Clears the value of 'count'

Field Description

The counter value

See Also:

setCount(long)

hasCount

boolean hasCount()

Checks for the presence of 'count'

Field Description

The counter value

See Also:

getCount()

setName

void setName(String val)

Sets the value of 'name'

Field Description

The name of the statistic

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'

Field Description

The name of the statistic

Returns:

The name of the statistic

lendName

void lendName(XString val)

Sets the value of 'name'

Field Description

The name of the statistic

Parameters:

val - The value to set.

setNameFrom

void setNameFrom(long val)

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

Field Description

The name of the statistic

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

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'

Field Description

The name of the statistic

See Also:

getName()