com.neeve.server.mon.cnc

Interface ISrvMonXvmInfoResponse

All Superinterfaces:

CopyableMessageView<ISrvMonXvmInfoResponse>, com.neeve.server.mon.common.IHasSrvMonXvmHeader, IRogCopyableNode<ISrvMonXvmInfoResponse>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, ISrvMonXvmResponse, IStoreObject, IStoreObjectMetadata, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonXvmInfoResponse

@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 ISrvMonXvmInfoResponse
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonXvmInfoResponse>, ISrvMonXvmResponse

Response containing XVM details.

ADM Details

ADM Type	Message
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
adminClientId	String	201	The admin client targeted in the command exchange.
correlationId	Long	202	The request correlation ID.
systemName	String	1	The system name to which the XVM belongs.
systemVersion	String	2	The version of the system to which the XVM belongs.
xvmAdminVersion	String	6005	The admin protocol version of an XVM.
xvmHeader	SrvMonXvmHeader	6004	Details about the message source.
xvmName	String	203	The name of the XVM targeted in the command exchange.

Nested Class Summary

Nested classes/interfaces inherited from interface com.neeve.rog.IRogNode

IRogNode.PoolingListener

Nested classes/interfaces inherited from interface com.neeve.ods.IStoreObject

IStoreObject.EncodingType

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAdminClientId() Clears the value of 'adminClientId'.
void	clearCorrelationId() Clears the value of 'correlationId'.
void	clearSystemName() Clears the value of 'systemName'.
void	clearSystemVersion() Clears the value of 'systemVersion'.
void	clearXvmAdminVersion() Clears the value of 'xvmAdminVersion'.
void	clearXvmHeader() Clears the value of 'xvmHeader'.
void	clearXvmName() Clears the value of 'xvmName'.
SrvMonXvmInfoResponse	copy() Creates a copy of this SrvMonXvmInfoResponse.
void	copyInto(SrvMonXvmInfoResponse target) Copies the contents of this SrvMonXvmInfoResponse into the target.
String	getAdminClientId() Gets the value of 'adminClientId'.
<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'.
long	getCorrelationId() Gets the value of 'correlationId'.
String	getSystemName() Gets the value of 'systemName'.
<T extends XString> T	getSystemNameTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemNameTo(XString val) Copies the value of 'systemName' into the provided XString.
XString	getSystemNameUnsafe() Gets the raw value of 'systemName'.
String	getSystemVersion() Gets the value of 'systemVersion'.
<T extends XString> T	getSystemVersionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getSystemVersionTo(XString val) Copies the value of 'systemVersion' into the provided XString.
XString	getSystemVersionUnsafe() Gets the raw value of 'systemVersion'.
String	getXvmAdminVersion() Gets the value of 'xvmAdminVersion'.
<T extends XString> T	getXvmAdminVersionTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getXvmAdminVersionTo(XString val) Copies the value of 'xvmAdminVersion' into the provided XString.
XString	getXvmAdminVersionUnsafe() Gets the raw value of 'xvmAdminVersion'.
com.neeve.server.mon.common.SrvMonXvmHeader	getXvmHeader() Gets the value of 'xvmHeader'.
void	getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val) Copies the value of SrvMonXvmHeader into the provided value.
String	getXvmName() Gets the value of 'xvmName'.
<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	hasSystemName() Checks for the presence of 'systemName'.
boolean	hasSystemVersion() Checks for the presence of 'systemVersion'.
boolean	hasXvmAdminVersion() Checks for the presence of 'xvmAdminVersion'.
boolean	hasXvmHeader() Checks for the presence of 'xvmHeader'.
boolean	hasXvmName() Checks for the presence of 'xvmName'.
void	lendAdminClientId(XString val) Lends the value of 'adminClientId' to this object.
void	lendSystemName(XString val) Lends the value of 'systemName' to this object.
void	lendSystemVersion(XString val) Lends the value of 'systemVersion' to this object.
void	lendXvmAdminVersion(XString val) Lends the value of 'xvmAdminVersion' 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.
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(XString val) Copies the provided XString value into this object's 'adminClientId'.
void	setCorrelationId(long val) Sets the value of 'correlationId'.
void	setSystemName(String val) Sets the value of 'systemName'.
void	setSystemNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemNameFrom(XString val) Copies the provided XString value into this object's 'systemName'.
void	setSystemVersion(String val) Sets the value of 'systemVersion'.
void	setSystemVersionFrom(long val) Sets the value of this String field to the given numeric value.
void	setSystemVersionFrom(XString val) Copies the provided XString value into this object's 'systemVersion'.
void	setXvmAdminVersion(String val) Sets the value of 'xvmAdminVersion'.
void	setXvmAdminVersionFrom(long val) Sets the value of this String field to the given numeric value.
void	setXvmAdminVersionFrom(XString val) Copies the provided XString value into this object's 'xvmAdminVersion'.
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(XString val) Copies the provided XString value into this object's 'xvmName'.
com.neeve.server.mon.common.SrvMonXvmHeader	takeXvmHeader() 'Takes' a reference to the xvmHeader field from the message.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, getIsLiveInboundMessage, getIsPriority, getIsReadOnly, getMetadata, getParent, getPoolingListener, getType, metadataToJsonString, serializeToProtobuf, setAsInboundMessage, setAsInternal, setAsLastTransaction, setAsMessage, setAsOutboundMessage, setAsPriority, setAsReadOnly, setAsReplayedMessage, setAttachment, setInMsgsInTransaction, setOutMsgsInTransaction, setParentId, setPoolingListener, setTransactionInSequenceNumber, setTransactionOutSequenceNumber

Methods inherited from interface com.neeve.ods.IStoreObject

acquire, deserialize, deserializeMetadata, deserializeMetadata, getContentEncodingType, getOwnershipCount, getSerializedMetadataLength, getStoreMetadata, serialize, serializeMetadata, setFieldValue

Methods inherited from interface com.neeve.ods.IStoreObjectMetadata

ensureId, getBinding, getCheckpointVersion, getCommittedDataSize, getId, getOfid, getStableTransactionId, getTransactionId, setBinding, setCheckpointVersion, setCommittedDataSize, setId, setStableTransactionId, setTransactionId

Methods inherited from interface com.neeve.sma.MapMessageView

getMessageReflector

Methods inherited from interface com.neeve.rog.IRogMetadata

getEnqueueTs, getEnqueueTsMicros, getGraphId, getInMsgsInTransaction, getIsInboundMessage, getIsInternal, getIsLastTransaction, getIsMessage, getIsOutboundMessage, getIsReplayedMessage, getMessageBus, getMessageChannel, getMessageFlow, getMessageKey, getMessageSender, getMessageSequenceNumber, getMessageTransportHeaders, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Method Detail

setCorrelationId

void setCorrelationId(long val)

Sets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

setCorrelationId in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

getCorrelationId

long getCorrelationId()

Gets the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

getCorrelationId in interface ISrvMonXvmResponse

Returns:

The request correlation ID

clearCorrelationId

void clearCorrelationId()

Clears the value of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

clearCorrelationId in interface ISrvMonXvmResponse

See Also:

setCorrelationId(long)

hasCorrelationId

boolean hasCorrelationId()

Checks for the presence of 'correlationId'.

Field Description

The request correlation ID.

Specified by:

hasCorrelationId in interface ISrvMonXvmResponse

See Also:

getCorrelationId()

setXvmHeader

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

Sets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

setXvmHeader in interface ISrvMonXvmResponse

Parameters:

val - The value to set.

lendXvmHeader

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

'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 com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

lendXvmHeader in interface ISrvMonXvmResponse

Parameters:

val - the value to 'lend' to lend.

getXvmHeader

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

Gets the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

getXvmHeader in interface ISrvMonXvmResponse

Returns:

Details about the message source.

getXvmHeaderTo

void getXvmHeaderTo(com.neeve.server.mon.common.SrvMonXvmHeader val)

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 com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

getXvmHeaderTo in interface ISrvMonXvmResponse

Parameters:

val - the value to copy into

See Also:

SrvMonXvmHeader.copyInto(SrvMonXvmHeader)

takeXvmHeader

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

'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 com.neeve.server.mon.common.IHasSrvMonXvmHeader

Specified by:

takeXvmHeader in interface ISrvMonXvmResponse

Returns:

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

hasXvmHeader

boolean hasXvmHeader()

Checks for the presence of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

hasXvmHeader in interface ISrvMonXvmResponse

See Also:

getXvmHeader()

clearXvmHeader

void clearXvmHeader()

Clears the value of 'xvmHeader'.

Field Description

Details about the message source.

Specified by:

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

Specified by:

clearXvmHeader in interface ISrvMonXvmResponse

See Also:

setXvmHeader(SrvMonXvmHeader)

setAdminClientId

void setAdminClientId(String val)

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

String getAdminClientId()

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

void lendAdminClientId(XString val)

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.

Throws:

IllegalArgumentException - If the value is mutable.

setAdminClientIdFrom

void setAdminClientIdFrom(long val)

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

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

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.

Throws:

NullPointerException - if the provided factory is null

setAdminClientIdFrom

void setAdminClientIdFrom(XString val)

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

void getAdminClientIdTo(XString val)

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

Specified by:

getAdminClientIdTo in interface ISrvMonXvmResponse

See Also:

getAdminClientId()

getAdminClientIdUnsafe

XString getAdminClientIdUnsafe()

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:

getAdminClientId()

clearAdminClientId

void clearAdminClientId()

Clears the value of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

clearAdminClientId in interface ISrvMonXvmResponse

See Also:

setAdminClientId(String)

hasAdminClientId

boolean hasAdminClientId()

Checks for the presence of 'adminClientId'.

Field Description

The admin client targeted in the command exchange.

Specified by:

hasAdminClientId in interface ISrvMonXvmResponse

See Also:

getAdminClientId()

setXvmName

void setXvmName(String val)

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

String getXvmName()

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

void lendXvmName(XString val)

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.

Throws:

IllegalArgumentException - If the value is mutable.

setXvmNameFrom

void setXvmNameFrom(long val)

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

<T extends XString> T getXvmNameTo(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 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.

Throws:

NullPointerException - if the provided factory is null

setXvmNameFrom

void setXvmNameFrom(XString val)

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

void getXvmNameTo(XString val)

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

Specified by:

getXvmNameTo in interface ISrvMonXvmResponse

See Also:

getXvmName()

getXvmNameUnsafe

XString getXvmNameUnsafe()

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:

getXvmName()

clearXvmName

void clearXvmName()

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:

setXvmName(String)

hasXvmName

boolean hasXvmName()

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:

getXvmName()

setXvmAdminVersion

void setXvmAdminVersion(String val)

Sets the value of 'xvmAdminVersion'.

Field Description

The admin protocol version of an XVM.

Parameters:

val - The value to set.

getXvmAdminVersion

String getXvmAdminVersion()

Gets the value of 'xvmAdminVersion'.

Field Description

The admin protocol version of an XVM.

Returns:

The admin protocol version of an XVM.

lendXvmAdminVersion

void lendXvmAdminVersion(XString val)

Lends the value of 'xvmAdminVersion' to this object.

This method is equivalent to setXvmAdminVersion 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 protocol version of an XVM.

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.

setXvmAdminVersionFrom

void setXvmAdminVersionFrom(long val)

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

Field Description

The admin protocol version of an XVM.

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

getXvmAdminVersionTo

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

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

Field Description

The admin protocol version of an XVM.

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

setXvmAdminVersionFrom

void setXvmAdminVersionFrom(XString val)

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

Field Description

The admin protocol version of an XVM.

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

getXvmAdminVersionTo

void getXvmAdminVersionTo(XString val)

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

Field Description

The admin protocol version of an XVM.

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

See Also:

getXvmAdminVersion()

getXvmAdminVersionUnsafe

XString getXvmAdminVersionUnsafe()

Gets the raw value of 'xvmAdminVersion'.

Field Description

The admin protocol version of an XVM.

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:

getXvmAdminVersion()

clearXvmAdminVersion

void clearXvmAdminVersion()

Clears the value of 'xvmAdminVersion'.

Field Description

The admin protocol version of an XVM.

See Also:

setXvmAdminVersion(String)

hasXvmAdminVersion

boolean hasXvmAdminVersion()

Checks for the presence of 'xvmAdminVersion'.

Field Description

The admin protocol version of an XVM.

See Also:

getXvmAdminVersion()

setSystemName

void setSystemName(String val)

Sets the value of 'systemName'.

Field Description

The system name to which the XVM belongs.

Parameters:

val - The value to set.

getSystemName

String getSystemName()

Gets the value of 'systemName'.

Field Description

The system name to which the XVM belongs.

Returns:

the system name to which the XVM belongs.

lendSystemName

void lendSystemName(XString val)

Lends the value of 'systemName' to this object.

This method is equivalent to setSystemName 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 system name to which the XVM belongs.

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.

setSystemNameFrom

void setSystemNameFrom(long val)

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

Field Description

The system name to which the XVM belongs.

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

getSystemNameTo

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

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

Field Description

The system name to which the XVM belongs.

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

setSystemNameFrom

void setSystemNameFrom(XString val)

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

Field Description

The system name to which the XVM belongs.

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

getSystemNameTo

void getSystemNameTo(XString val)

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

Field Description

The system name to which the XVM belongs.

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

See Also:

getSystemName()

getSystemNameUnsafe

XString getSystemNameUnsafe()

Gets the raw value of 'systemName'.

Field Description

The system name to which the XVM belongs.

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:

getSystemName()

clearSystemName

void clearSystemName()

Clears the value of 'systemName'.

Field Description

The system name to which the XVM belongs.

See Also:

setSystemName(String)

hasSystemName

boolean hasSystemName()

Checks for the presence of 'systemName'.

Field Description

The system name to which the XVM belongs.

See Also:

getSystemName()

setSystemVersion

void setSystemVersion(String val)

Sets the value of 'systemVersion'.

Field Description

The version of the system to which the XVM belongs.

Parameters:

val - The value to set.

getSystemVersion

String getSystemVersion()

Gets the value of 'systemVersion'.

Field Description

The version of the system to which the XVM belongs.

Returns:

the version of the system to which the XVM belongs.

lendSystemVersion

void lendSystemVersion(XString val)

Lends the value of 'systemVersion' to this object.

This method is equivalent to setSystemVersion 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 version of the system to which the XVM belongs.

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.

setSystemVersionFrom

void setSystemVersionFrom(long val)

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

Field Description

The version of the system to which the XVM belongs.

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

getSystemVersionTo

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

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

Field Description

The version of the system to which the XVM belongs.

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

setSystemVersionFrom

void setSystemVersionFrom(XString val)

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

Field Description

The version of the system to which the XVM belongs.

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

getSystemVersionTo

void getSystemVersionTo(XString val)

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

Field Description

The version of the system to which the XVM belongs.

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

See Also:

getSystemVersion()

getSystemVersionUnsafe

XString getSystemVersionUnsafe()

Gets the raw value of 'systemVersion'.

Field Description

The version of the system to which the XVM belongs.

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:

getSystemVersion()

clearSystemVersion

void clearSystemVersion()

Clears the value of 'systemVersion'.

Field Description

The version of the system to which the XVM belongs.

See Also:

setSystemVersion(String)

hasSystemVersion

boolean hasSystemVersion()

Checks for the presence of 'systemVersion'.

Field Description

The version of the system to which the XVM belongs.

See Also:

getSystemVersion()

copy

SrvMonXvmInfoResponse copy()

Creates a copy of this SrvMonXvmInfoResponse.

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

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

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Specified by:

copy in interface CopyableMessageView<ISrvMonXvmInfoResponse>

Specified by:

copy in interface IRogCopyableNode<ISrvMonXvmInfoResponse>

Returns:

A copy of this SrvMonXvmInfoResponse.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonXvmInfoResponse target)

Copies the contents of this SrvMonXvmInfoResponse 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 SrvMonXvmInfoResponse's embedded entity fields.

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

No metadata is copied except as documented IRogCopyableNode. See IRogCopyableNode for more detailed information on the semantics of this method.

Parameters:

target - The target to copy into which must not be null or read only.