com.neeve.server.mon
Interface ISrvMonUserSeriesStat

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonUserSeriesStat

@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 ISrvMonUserSeriesStat
extends IRogValidatable

An application defined latency collection statistic.

Method Summary

void	clearIntSeries() Clears the value of 'intSeries' Field Description The collected int series data for an INT series.
void	clearName() Clears the value of 'name' Field Description The name of the statistic
void	clearSeriesType() Clears the value of 'seriesType' Field Description The type of the series data collected.
SrvMonIntSeries	getIntSeries() Gets the value of 'intSeries' Field Description The collected int series data for an INT series.
void	getIntSeriesTo(SrvMonIntSeries val) Copies the value of SrvMonIntSeries into the provided 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'.
SrvMonSeriesType	getSeriesType() Gets the value of 'seriesType' Field Description The type of the series data collected.
boolean	hasIntSeries() Checks for the presence of 'intSeries' Field Description The collected int series data for an INT series.
boolean	hasName() Checks for the presence of 'name' Field Description The name of the statistic
boolean	hasSeriesType() Checks for the presence of 'seriesType' Field Description The type of the series data collected.
void	lendIntSeries(SrvMonIntSeries val) 'Lends' a reference of the SrvMonIntSeries to the message for this field.
void	lendName(XString val) Sets the value of 'name' Field Description The name of the statistic
void	setIntSeries(SrvMonIntSeries val) Sets the value of 'intSeries' Field Description The collected int series data for an INT series.
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'.
void	setSeriesType(SrvMonSeriesType val) Sets the value of 'seriesType' Field Description The type of the series data collected.
SrvMonIntSeries	takeIntSeries() 'Takes' a reference to the intSeries field from the message.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setSeriesType

void setSeriesType(SrvMonSeriesType val)

Sets the value of 'seriesType'

Field Description

The type of the series data collected.

Parameters:

val - The value to set.

getSeriesType

SrvMonSeriesType getSeriesType()

Gets the value of 'seriesType'

Field Description

The type of the series data collected.

Returns:

The type of the series data collected.

clearSeriesType

void clearSeriesType()

Clears the value of 'seriesType'

Field Description

The type of the series data collected.

See Also:

setSeriesType(SrvMonSeriesType)

hasSeriesType

boolean hasSeriesType()

Checks for the presence of 'seriesType'

Field Description

The type of the series data collected.

See Also:

getSeriesType()

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

setIntSeries

void setIntSeries(SrvMonIntSeries val)

Sets the value of 'intSeries'

Field Description

The collected int series data for an INT series.

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

Parameters:

val - The value to set.

lendIntSeries

void lendIntSeries(SrvMonIntSeries val)

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

Field Description

The collected int series data for an INT series.

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

NOTE:
It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().

To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.

Parameters:

val - the value to 'lend' to lend.

getIntSeries

SrvMonIntSeries getIntSeries()

Gets the value of 'intSeries'

Field Description

The collected int series data for an INT series.

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

Returns:

The collected int series data for an INT series.

getIntSeriesTo

void getIntSeriesTo(SrvMonIntSeries val)

Copies the value of SrvMonIntSeries into the provided value.

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

Parameters:

val - the value to copy into

See Also:

SrvMonIntSeries.copyInto(SrvMonIntSeries)

takeIntSeries

SrvMonIntSeries takeIntSeries()

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

Field Description

The collected int series data for an INT series.

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

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

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

Returns:

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

hasIntSeries

boolean hasIntSeries()

Checks for the presence of 'intSeries'

Field Description

The collected int series data for an INT series.

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

See Also:

getIntSeries()

clearIntSeries

void clearIntSeries()

Clears the value of 'intSeries'

Field Description

The collected int series data for an INT series.

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

See Also:

setIntSeries(SrvMonIntSeries)