|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.neeve.server.mon.SrvMonUserSeriesStat
@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=219) public final class SrvMonUserSeriesStat
An application defined latency collection statistic.
Nested Class Summary | |
---|---|
static class |
SrvMonUserSeriesStat.Field
The SrvMonUserSeriesStat xbuf field (used internally when this entity is used as a field of another entity). |
static class |
SrvMonUserSeriesStat.ListField
The SrvMonUserSeriesStat list field (used internally when this entity is used as an array field of another entity). |
Field Summary | |
---|---|
static SrvMonUserSeriesStat[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type. |
Constructor Summary | |
---|---|
SrvMonUserSeriesStat()
|
|
SrvMonUserSeriesStat(int initialBackingBufferSize)
|
Method Summary | ||
---|---|---|
SrvMonUserSeriesStat |
acquire()
|
|
void |
clearContent()
|
|
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. |
|
void |
clearXRogType()
|
|
Object |
clone()
Creates a clone of this object. |
|
SrvMonUserSeriesStat |
copy()
Creates a copy of this SrvMonUserSeriesStat. |
|
void |
copyInto(SrvMonUserSeriesStat copy)
Copies the contents of this SrvMonUserSeriesStat into the target. |
|
static SrvMonUserSeriesStat |
create()
|
|
static SrvMonUserSeriesStat |
createFrom(byte[] serializedContainer)
|
|
static SrvMonUserSeriesStat |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
static SrvMonUserSeriesStat |
createFromSerializedXbufContainer(byte[] serializedContainer)
|
|
static SrvMonUserSeriesStat |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
static com.neeve.xbuf.XbufSchema |
createSchema()
|
|
SrvMonUserSeriesStat |
deserializeFromByteArray(byte[] array)
|
|
SrvMonUserSeriesStat |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonUserSeriesStat |
deserializeFromByteBuffer(ByteBuffer buffer)
|
|
SrvMonUserSeriesStat |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonUserSeriesStat |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length)
|
|
SrvMonUserSeriesStat |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
|
|
SrvMonUserSeriesStat |
deserializeFromNative(long address,
int offset,
int length)
|
|
SrvMonUserSeriesStat |
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()
|
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy()
|
|
SrvMonIntSeries |
getIntSeries()
Gets the value of 'intSeries' Field Description The collected int series data for an INT series. |
|
static int |
getIntSeriesFieldId()
Get the field id for 'intSeries' This method can be used to set field interests. |
|
void |
getIntSeriesTo(SrvMonIntSeries to)
Copies the value of SrvMonIntSeries into the provided value. |
|
boolean |
getIsReadOnly()
|
|
String |
getName()
Gets the value of 'name' Field Description The name of the statistic |
|
com.neeve.xbuf.XbufStringField |
getNameField()
|
|
static int |
getNameFieldId()
Get the field id for 'name' This method can be used to set field interests. |
|
|
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<SrvMonUserSeriesStat> |
getPool()
Get a pool item's pool. |
|
int |
getSerializeToNativeLength()
|
|
SrvMonSeriesType |
getSeriesType()
Gets the value of 'seriesType' Field Description The type of the series data collected. |
|
com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> |
getSeriesTypeField()
|
|
static int |
getSeriesTypeFieldId()
Get the field id for 'seriesType' This method can be used to set field interests. |
|
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 |
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. |
|
boolean |
hasXRogType()
|
|
SrvMonUserSeriesStat |
init()
Initialize an item. |
|
boolean |
isBufferBacked()
|
|
boolean |
isDirty()
|
|
boolean |
isReferenceCounted()
|
|
boolean |
isValid()
Tests if this object has any validation errors. |
|
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 |
|
static void |
optimizeFor(int val)
|
|
byte[] |
serializeToByteArray()
|
|
ByteBuffer |
serializeToByteBuffer()
|
|
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative)
|
|
int |
serializeToNative(long address,
int addressOffset)
|
|
void |
setAsReadOnly()
|
|
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
|
|
static void |
setFieldInterest(List<Integer> fieldIds)
|
|
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(com.neeve.xbuf.XbufStringField val)
|
|
void |
setNameFrom(XString val)
Copies the provided XString value into this object's 'name'. |
|
SrvMonUserSeriesStat |
setPool(UtlPool<SrvMonUserSeriesStat> pool)
Set a pool item's pool. |
|
void |
setSeriesType(SrvMonSeriesType val)
Sets the value of 'seriesType' Field Description The type of the series data collected. |
|
void |
setSeriesTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> val)
|
|
void |
setXRogType(short val)
|
|
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
|
|
void |
sync()
|
|
void |
syncFieldBitmask()
|
|
SrvMonIntSeries |
takeIntSeries()
'Takes' a reference to the intSeries field from the message. |
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final SrvMonUserSeriesStat[] EMPTY_ARRAY
Constructor Detail |
---|
public SrvMonUserSeriesStat()
public SrvMonUserSeriesStat(int initialBackingBufferSize)
Method Detail |
---|
public static SrvMonUserSeriesStat create()
public static SrvMonUserSeriesStat createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonUserSeriesStat createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonUserSeriesStat createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonUserSeriesStat createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public static final void setFieldInterest(List<Integer> fieldIds)
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 static final int getXRogTypeFieldId()
This method can be used to set field interests.
getXRogType()
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 getSeriesTypeFieldId()
This method can be used to set field interests.
getSeriesType()
public final void setSeriesType(SrvMonSeriesType val)
ISrvMonUserSeriesStat
setSeriesType
in interface ISrvMonUserSeriesStat
val
- The value to set.public final void setSeriesTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonSeriesType> getSeriesTypeField()
public final SrvMonSeriesType getSeriesType()
ISrvMonUserSeriesStat
getSeriesType
in interface ISrvMonUserSeriesStat
public final boolean hasSeriesType()
ISrvMonUserSeriesStat
hasSeriesType
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.getSeriesType()
public final void clearSeriesType()
ISrvMonUserSeriesStat
clearSeriesType
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.setSeriesType(SrvMonSeriesType)
public static final int getNameFieldId()
This method can be used to set field interests.
getName()
public final void setName(String val)
ISrvMonUserSeriesStat
setName
in interface ISrvMonUserSeriesStat
val
- The value to set.public final String getName()
ISrvMonUserSeriesStat
getName
in interface ISrvMonUserSeriesStat
public final void lendName(XString val)
ISrvMonUserSeriesStat
lendName
in interface ISrvMonUserSeriesStat
val
- The value to set.public final void setNameFrom(long val)
ISrvMonUserSeriesStat
NOTE:
This is the same as calling ISrvMonUserSeriesStat.setName(String)
.
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setNameFrom
in interface ISrvMonUserSeriesStat
public final <T extends XString> T getNameTo(XString.Factory<T> factory)
ISrvMonUserSeriesStat
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 ISrvMonUserSeriesStat
factory
- The factory from which to get the XString to copy into and return
null
.public final void setNameFrom(XString val)
ISrvMonUserSeriesStat
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonUserSeriesStat.setName(String)
because it avoids encoding the value into a String
if the given XString
is already encoded.
setNameFrom
in interface ISrvMonUserSeriesStat
public final void getNameTo(XString val)
ISrvMonUserSeriesStat
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonUserSeriesStat.getName()
bec
because it can avoid decoding the value into an String
.
getNameTo
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.getName()
public final XString getNameUnsafe()
ISrvMonUserSeriesStat
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 ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.getName()
public final void setNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getNameField()
public final boolean hasName()
ISrvMonUserSeriesStat
hasName
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.getName()
public final void clearName()
ISrvMonUserSeriesStat
clearName
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.setName(String)
public static final int getIntSeriesFieldId()
This method can be used to set field interests.
getIntSeries()
public final void setIntSeries(SrvMonIntSeries val)
ISrvMonUserSeriesStat
This field should only be set when the series type is set to SrvMonSeriesType.INT.
setIntSeries
in interface ISrvMonUserSeriesStat
val
- The value to set.public final void lendIntSeries(SrvMonIntSeries val)
ISrvMonUserSeriesStat
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.
lendIntSeries
in interface ISrvMonUserSeriesStat
val
- the value to 'lend' to lend.public final SrvMonIntSeries getIntSeries()
ISrvMonUserSeriesStat
This field should only be set when the series type is set to SrvMonSeriesType.INT.
getIntSeries
in interface ISrvMonUserSeriesStat
public final void getIntSeriesTo(SrvMonIntSeries to)
ISrvMonUserSeriesStat
IF the value is not set, then the contents of the provided SrvMonIntSeries are cleared.
getIntSeriesTo
in interface ISrvMonUserSeriesStat
to
- the value to copy intoSrvMonIntSeries.copyInto(SrvMonIntSeries)
public final SrvMonIntSeries takeIntSeries()
ISrvMonUserSeriesStat
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.
takeIntSeries
in interface ISrvMonUserSeriesStat
null
if the field is not set.public final boolean hasIntSeries()
ISrvMonUserSeriesStat
This field should only be set when the series type is set to SrvMonSeriesType.INT.
hasIntSeries
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.getIntSeries()
public final void clearIntSeries()
ISrvMonUserSeriesStat
This field should only be set when the series type is set to SrvMonSeriesType.INT.
clearIntSeries
in interface ISrvMonUserSeriesStat
ISrvMonUserSeriesStat.setIntSeries(SrvMonIntSeries)
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 SrvMonUserSeriesStat deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserSeriesStat deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonUserSeriesStat deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserSeriesStat deserializeFromByteArray(byte[] array)
public final SrvMonUserSeriesStat deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserSeriesStat deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonUserSeriesStat deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonUserSeriesStat deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
desync
in interface com.neeve.xbuf.IXbufDesyncer
public final SrvMonUserSeriesStat 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<SrvMonUserSeriesStat>
public final SrvMonUserSeriesStat setPool(UtlPool<SrvMonUserSeriesStat> 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<SrvMonUserSeriesStat>
public final UtlPool<SrvMonUserSeriesStat> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool
getPool
in interface UtlPool.Item<SrvMonUserSeriesStat>
UtlPool.Item.setPool(com.neeve.util.UtlPool)
public final boolean isReferenceCounted()
public final SrvMonUserSeriesStat acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy()
method in that:
clone
in class Object
public final SrvMonUserSeriesStat 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 SrvMonUserSeriesStat's embedded entity fields.
The returned copy will be writeable even if this SrvMonUserSeriesStat is read only.
public final void copyInto(SrvMonUserSeriesStat 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 SrvMonUserSeriesStat's embedded entity fields.
The returned copy will be writeable even if this SrvMonUserSeriesStat 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.public final String toString()
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |