com.neeve.server.mon.cnc

Class SrvMonXvmResponse

java.lang.Object

com.neeve.server.mon.cnc.SrvMonXvmResponse

All Implemented Interfaces:

IRogValidatable, ISrvMonXvmResponse, com.neeve.server.mon.common.IHasSrvMonXvmHeader, UtlPool.Item<SrvMonXvmResponse>, com.neeve.xbuf.IXbufDesyncer

@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=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=304)
public final class SrvMonXvmResponse
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonXvmResponse>, ISrvMonXvmResponse

Defines response header fields.

Command and control request metadata about the admin client that initiated the request or is targeted in a repsonse.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientId	String	216	The admin client targeted in the command exchange.
correlationId	Long	217	The request correlation ID.
xvmHeader	SrvMonXvmHeader	6019	Details about the message source.
xvmName	String	218	The name of the XVM targeted in the command exchange.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SrvMonXvmResponse.Field The SrvMonXvmResponse xbuf field (used internally when this entity is used as a field of another entity).
static class	SrvMonXvmResponse.ListField The SrvMonXvmResponse list field (used internally when this entity is used as an array field of another entity).

Field Summary

Fields

Modifier and Type	Field and Description
static SrvMonXvmResponse[]	EMPTY_ARRAY A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Summary

Constructors

Constructor and Description
SrvMonXvmResponse()
SrvMonXvmResponse(int initialBackingBufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
SrvMonXvmResponse	acquire()
void	clearAdminClientId() Clears the value of 'adminClientId'.
void	clearContent()
void	clearCorrelationId() Clears the value of 'correlationId'.
void	clearXRogType()
void	clearXvmHeader() Clears the value of 'xvmHeader'.
void	clearXvmName() Clears the value of 'xvmName'.
Object	clone() Creates a clone of this object.
SrvMonXvmResponse	copy() Creates a copy of this SrvMonXvmResponse.
void	copyInto(SrvMonXvmResponse copy) Copies the contents of this SrvMonXvmResponse into the target.
static SrvMonXvmResponse	create()
static SrvMonXvmResponse	createFrom(byte[] serializedContainer)
static SrvMonXvmResponse	createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static SrvMonXvmResponse	createFromSerializedXbufContainer(byte[] serializedContainer)
static SrvMonXvmResponse	createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
static com.neeve.xbuf.XbufSchema	createSchema()
SrvMonXvmResponse	deserializeFromByteArray(byte[] array)
SrvMonXvmResponse	deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonXvmResponse	deserializeFromByteBuffer(ByteBuffer buffer)
SrvMonXvmResponse	deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonXvmResponse	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
SrvMonXvmResponse	deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
SrvMonXvmResponse	deserializeFromNative(long address, int offset, int length)
SrvMonXvmResponse	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()
String	getAdminClientId() Gets the value of 'adminClientId'.
com.neeve.xbuf.XbufStringField	getAdminClientIdField()
static int	getAdminClientIdFieldId()
<T extends XString> T	getAdminClientIdTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getAdminClientIdTo(XString val) Copies the value of 'adminClientId' into the provided XString.
XString	getAdminClientIdUnsafe() Gets the raw value of 'adminClientId'.
PktBuffer	getBackingBuffer()
long	getCorrelationId() Gets the value of 'correlationId'.
com.neeve.xbuf.XbufVariableLongField	getCorrelationIdField()
static int	getCorrelationIdFieldId()
static com.neeve.xbuf.XbufDesyncPolicy	getDesyncPolicy()
boolean	getIsReadOnly()
int	getOwnerCount()
UtlPool<SrvMonXvmResponse>	getPool() Get a pool item's pool.
int	getSerializeToNativeLength()
void	getValidationErrors(List<XString> results, String errorPrefix) Collects validation errors into the provided list.
short	getXRogType()
com.neeve.xbuf.XbufVariableShortField	getXRogTypeField()
static int	getXRogTypeFieldId()
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
static int	getXvmHeaderFieldId()
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to) Copies the value of SrvMonXvmHeader into the provided value.
String	getXvmName() Gets the value of 'xvmName'.
com.neeve.xbuf.XbufStringField	getXvmNameField()
static int	getXvmNameFieldId()
<T extends XString> T	getXvmNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getXvmNameTo(XString val) Copies the value of 'xvmName' into the provided XString.
XString	getXvmNameUnsafe() Gets the raw value of 'xvmName'.
boolean	hasAdminClientId() Checks for the presence of 'adminClientId'.
boolean	hasCorrelationId() Checks for the presence of 'correlationId'.
boolean	hasXRogType()
boolean	hasXvmHeader() Checks for the presence of 'xvmHeader'.
boolean	hasXvmName() Checks for the presence of 'xvmName'.
SrvMonXvmResponse	init() Initialize an item.
boolean	isBufferBacked()
boolean	isDirty()
boolean	isReferenceCounted()
boolean	isValid() Tests if this object has any validation errors.
void	lendAdminClientId(XString val) Lends the value of 'adminClientId' to this object.
void	lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) 'Lends' a reference of the SrvMonXvmHeader to the message for this field.
void	lendXvmName(XString val) Lends the value of 'xvmName' 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	setAdminClientId(String val) Sets the value of 'adminClientId'.
void	setAdminClientIdFrom(long val) Sets the value of this String field to the given numeric value.
void	setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)
void	setAdminClientIdFrom(XString val) Copies the provided XString value into this object's 'adminClientId'.
void	setAsReadOnly()
void	setCorrelationId(long val) Sets the value of 'correlationId'.
void	setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)
static void	setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
static void	setFieldInterest(List<Integer> fieldIds)
SrvMonXvmResponse	setPool(UtlPool<SrvMonXvmResponse> pool) Set a pool item's pool.
void	setPreserializedFields(PktBuffer buffer)
void	setXRogType(short val)
void	setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
void	setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val) Sets the value of 'xvmHeader'.
void	setXvmName(String val) Sets the value of 'xvmName'.
void	setXvmNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setXvmNameFrom(com.neeve.xbuf.XbufStringField val)
void	setXvmNameFrom(XString val) Copies the provided XString value into this object's 'xvmName'.
void	sync()
void	syncFieldBitmask()
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

EMPTY_ARRAY

public static final SrvMonXvmResponse[] EMPTY_ARRAY

A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Detail

SrvMonXvmResponse

public SrvMonXvmResponse()

SrvMonXvmResponse

public SrvMonXvmResponse(int initialBackingBufferSize)

Method Detail

create

public static SrvMonXvmResponse create()

createFromSerializedXbufContainer

public static SrvMonXvmResponse createFromSerializedXbufContainer(byte[] serializedContainer,
                                                  com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static SrvMonXvmResponse createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static SrvMonXvmResponse createFrom(byte[] serializedContainer,
                           com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static SrvMonXvmResponse createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

setPreserializedFields

public final void setPreserializedFields(PktBuffer buffer)

getXRogTypeFieldId

public static final int getXRogTypeFieldId()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getCorrelationIdFieldId

public static final int getCorrelationIdFieldId()

setCorrelationId

public final void setCorrelationId(long val)

Description copied from interface: ISrvMonXvmResponse

Sets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

setCorrelationId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getCorrelationId

public final long getCorrelationId()

Description copied from interface: ISrvMonXvmResponse

Gets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

getCorrelationId in interface ISrvMonXvmResponse

Returns:

The request correlation ID

setCorrelationIdFrom

public final void setCorrelationIdFrom(com.neeve.xbuf.XbufVariableLongField val)

getCorrelationIdField

public final com.neeve.xbuf.XbufVariableLongField getCorrelationIdField()

hasCorrelationId

public final boolean hasCorrelationId()

Description copied from interface: ISrvMonXvmResponse

Checks for the presence of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

hasCorrelationId in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.getCorrelationId()

clearCorrelationId

public final void clearCorrelationId()

Description copied from interface: ISrvMonXvmResponse

Clears the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

clearCorrelationId in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.setCorrelationId(long)

getXvmHeaderFieldId

public static final int getXvmHeaderFieldId()

setXvmHeader

public final void setXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

Description copied from interface: ISrvMonXvmResponse

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

setXvmHeader in interface ISrvMonXvmResponse

Specified by:

setXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

val - The value to set.

lendXvmHeader

public final void lendXvmHeader(com.neeve.server.mon.common.SrvMonXvmHeader val)

Description copied from interface: ISrvMonXvmResponse

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

Field Description

Details about the message source.

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.

Specified by:

lendXvmHeader in interface ISrvMonXvmResponse

Specified by:

lendXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

public final com.neeve.server.mon.common.SrvMonXvmHeader getXvmHeader()

Description copied from interface: ISrvMonXvmResponse

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

getXvmHeader in interface ISrvMonXvmResponse

Specified by:

getXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Returns:

Details about the message source.

getXvmHeaderTo

public final void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader to)

Description copied from interface: ISrvMonXvmResponse

Copies the value of SrvMonXvmHeader into the provided value.

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

Specified by:

getXvmHeaderTo in interface ISrvMonXvmResponse

Specified by:

getXvmHeaderTo in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Parameters:

to - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

public final com.neeve.server.mon.common.SrvMonXvmHeader takeXvmHeader()

Description copied from interface: ISrvMonXvmResponse

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

Field Description

Details about the message source.

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.

Specified by:

takeXvmHeader in interface ISrvMonXvmResponse

Specified by:

takeXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

Returns:

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

hasXvmHeader

public final boolean hasXvmHeader()

Description copied from interface: ISrvMonXvmResponse

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

hasXvmHeader in interface ISrvMonXvmResponse

Specified by:

hasXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

See Also:

ISrvMonXvmResponse.getXvmHeader()

clearXvmHeader

public final void clearXvmHeader()

Description copied from interface: ISrvMonXvmResponse

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

clearXvmHeader in interface ISrvMonXvmResponse

Specified by:

clearXvmHeader in interface com.neeve.server.mon.common.IHasSrvMonXvmHeader

See Also:

ISrvMonXvmResponse.setXvmHeader(SrvMonXvmHeader)

getAdminClientIdFieldId

public static final int getAdminClientIdFieldId()

setAdminClientId

public final void setAdminClientId(String val)

Description copied from interface: ISrvMonXvmResponse

Sets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

setAdminClientId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getAdminClientId

public final String getAdminClientId()

Description copied from interface: ISrvMonXvmResponse

Gets the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

getAdminClientId in interface ISrvMonXvmResponse

Returns:

The admin client targeted in the command exchange

lendAdminClientId

public final void lendAdminClientId(XString val)

Description copied from interface: ISrvMonXvmResponse

Lends the value of 'adminClientId' to this object.

This method is equivalent to setAdminClientId 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 admin client targeted in the command exchange.

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.

Specified by:

lendAdminClientId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

setAdminClientIdFrom

public final void setAdminClientIdFrom(long val)

Description copied from interface: ISrvMonXvmResponse

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

Field Description

The admin client targeted in the command exchange.

NOTE:
This is the same as calling ISrvMonXvmResponse.setAdminClientId(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setAdminClientIdFrom in interface ISrvMonXvmResponse

getAdminClientIdTo

public final <T extends XString> T getAdminClientIdTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonXvmResponse

Copies the value of this String field into a new XString from the given factory.

Field Description

The admin client targeted in the command exchange.

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;

Specified by:

getAdminClientIdTo in interface ISrvMonXvmResponse

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.

setAdminClientIdFrom

public final void setAdminClientIdFrom(XString val)

Description copied from interface: ISrvMonXvmResponse

Copies the provided XString value into this object's 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonXvmResponse.setAdminClientId(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setAdminClientIdFrom in interface ISrvMonXvmResponse

getAdminClientIdTo

public final void getAdminClientIdTo(XString val)

Description copied from interface: ISrvMonXvmResponse

Copies the value of 'adminClientId' into the provided XString.

Field Description

The admin client targeted in the command exchange.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonXvmResponse.getAdminClientId() bec because it can avoid decoding the value into an String.

Specified by:

getAdminClientIdTo in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.getAdminClientId()

getAdminClientIdUnsafe

public final XString getAdminClientIdUnsafe()

Description copied from interface: ISrvMonXvmResponse

Gets the raw value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

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.

Specified by:

getAdminClientIdUnsafe in interface ISrvMonXvmResponse

Returns:

the field's raw value

See Also:

ISrvMonXvmResponse.getAdminClientId()

setAdminClientIdFrom

public final void setAdminClientIdFrom(com.neeve.xbuf.XbufStringField val)

getAdminClientIdField

public final com.neeve.xbuf.XbufStringField getAdminClientIdField()

hasAdminClientId

public final boolean hasAdminClientId()

Description copied from interface: ISrvMonXvmResponse

Checks for the presence of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

hasAdminClientId in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.getAdminClientId()

clearAdminClientId

public final void clearAdminClientId()

Description copied from interface: ISrvMonXvmResponse

Clears the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

clearAdminClientId in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.setAdminClientId(String)

getXvmNameFieldId

public static final int getXvmNameFieldId()

setXvmName

public final void setXvmName(String val)

Description copied from interface: ISrvMonXvmResponse

Sets the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

setXvmName in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getXvmName

public final String getXvmName()

Description copied from interface: ISrvMonXvmResponse

Gets the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

getXvmName in interface ISrvMonXvmResponse

Returns:

The name of the XVM targeted in the command exchange

lendXvmName

public final void lendXvmName(XString val)

Description copied from interface: ISrvMonXvmResponse

Lends the value of 'xvmName' to this object.

This method is equivalent to setXvmName 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 XVM targeted in the command exchange.

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.

Specified by:

lendXvmName in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

setXvmNameFrom

public final void setXvmNameFrom(long val)

Description copied from interface: ISrvMonXvmResponse

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

Field Description

The name of the XVM targeted in the command exchange.

NOTE:
This is the same as calling ISrvMonXvmResponse.setXvmName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

Specified by:

setXvmNameFrom in interface ISrvMonXvmResponse

getXvmNameTo

public final <T extends XString> T getXvmNameTo(XString.Factory<T> factory)

Description copied from interface: ISrvMonXvmResponse

Copies the value of this String field into a new XString from the given factory.

Field Description

The name of the XVM targeted in the command exchange.

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;

Specified by:

getXvmNameTo in interface ISrvMonXvmResponse

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.

setXvmNameFrom

public final void setXvmNameFrom(XString val)

Description copied from interface: ISrvMonXvmResponse

Copies the provided XString value into this object's 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonXvmResponse.setXvmName(String) because it avoids encoding the value into a String if the given XString is already encoded.

Specified by:

setXvmNameFrom in interface ISrvMonXvmResponse

getXvmNameTo

public final void getXvmNameTo(XString val)

Description copied from interface: ISrvMonXvmResponse

Copies the value of 'xvmName' into the provided XString.

Field Description

The name of the XVM targeted in the command exchange.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonXvmResponse.getXvmName() bec because it can avoid decoding the value into an String.

Specified by:

getXvmNameTo in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.getXvmName()

getXvmNameUnsafe

public final XString getXvmNameUnsafe()

Description copied from interface: ISrvMonXvmResponse

Gets the raw value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

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.

Specified by:

getXvmNameUnsafe in interface ISrvMonXvmResponse

Returns:

the field's raw value

See Also:

ISrvMonXvmResponse.getXvmName()

setXvmNameFrom

public final void setXvmNameFrom(com.neeve.xbuf.XbufStringField val)

getXvmNameField

public final com.neeve.xbuf.XbufStringField getXvmNameField()

hasXvmName

public final boolean hasXvmName()

Description copied from interface: ISrvMonXvmResponse

Checks for the presence of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

hasXvmName in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.getXvmName()

clearXvmName

public final void clearXvmName()

Description copied from interface: ISrvMonXvmResponse

Clears the value of 'xvmName'.

Field Description

The name of the XVM targeted in the command exchange.

Specified by:

clearXvmName in interface ISrvMonXvmResponse

See Also:

ISrvMonXvmResponse.setXvmName(String)

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                    int addressOffset)

deserializeFromIOElasticBuffer

public final SrvMonXvmResponse deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                               int offset,
                                               int length,
                                               com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final SrvMonXvmResponse deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                               int offset,
                                               int length)

deserializeFromByteArray

public final SrvMonXvmResponse deserializeFromByteArray(byte[] array,
                                         com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final SrvMonXvmResponse deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final SrvMonXvmResponse deserializeFromByteBuffer(ByteBuffer buffer,
                                          com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final SrvMonXvmResponse deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final SrvMonXvmResponse deserializeFromNative(long address,
                                      int offset,
                                      int length,
                                      com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final SrvMonXvmResponse deserializeFromNative(long address,
                                      int offset,
                                      int length)

sync

public final void sync()

desync

public final int desync(PktBuffer buffer,
         int pos,
         boolean frameOnly)

Description copied from interface: com.neeve.xbuf.IXbufDesyncer

Desync fields from a buffer

Specified by:

desync in interface com.neeve.xbuf.IXbufDesyncer

Parameters:

buffer - The buffer to desync from

pos - The position in the container's backing buffer to desync from

frameOnly - Whether to frame the field on the underlying buffer. See XbufField.desync(PktBuffer, int, boolean) for more information

init

public final SrvMonXvmResponse init()

Description copied from interface: UtlPool.Item

Initialize an 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.

Specified by:

init in interface UtlPool.Item<SrvMonXvmResponse>

Returns:

Return 'this' object for method invocation chaining.

setPool

public final SrvMonXvmResponse setPool(UtlPool<SrvMonXvmResponse> pool)

Description copied from interface: UtlPool.Item

Set a pool item's pool.

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.

Specified by:

setPool in interface UtlPool.Item<SrvMonXvmResponse>

Returns:

Return 'this' object for method invocation chaining.

getPool

public final UtlPool<SrvMonXvmResponse> getPool()

Description copied from interface: UtlPool.Item

Get a pool item's pool.

This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)

Specified by:

getPool in interface UtlPool.Item<SrvMonXvmResponse>

Returns:

the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonXvmResponse acquire()

getOwnerCount

public final int getOwnerCount()

dispose

public final void dispose()

clone

public final Object clone()

Creates a clone of this object.

This method differs from the copy() method in that:

• For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
• The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.

Overrides:

clone in class Object

copy

public final SrvMonXvmResponse copy()

Creates a copy of this SrvMonXvmResponse.

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 SrvMonXvmResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonXvmResponse is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Returns:

The copied entity.

copyInto

public final void copyInto(SrvMonXvmResponse copy)

Copies the contents of this SrvMonXvmResponse into the target.

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 SrvMonXvmResponse's embedded entity fields.

The returned copy will be writeable even if this SrvMonXvmResponse is read only.

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Parameters:

copy - The target into which to copy.

isValid

public final boolean isValid()

Description copied from interface: IRogValidatable

Tests if this object has any validation errors.

Specified by:

isValid in interface IRogValidatable

getValidationErrors

public final void getValidationErrors(List<XString> results,
                       String errorPrefix)

Description copied from interface: IRogValidatable

Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.

Specified by:

getValidationErrors in interface IRogValidatable

Parameters:

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.

toString

public final String toString()

Overrides:

toString in class Object