com.neeve.server.mon.cnc
Interface ISrvMonInvokeCommandResponse

All Superinterfaces:

CopyableMessageView<ISrvMonInvokeCommandResponse>, IRogCopyableNode<ISrvMonInvokeCommandResponse>, IRogMessage, IRogMetadata, IRogNode, IRogValidatable, IStoreObject, MapMessageView, MessageView, UtlReferenceTracker.HasReferenceTracker

All Known Implementing Classes:

SrvMonInvokeCommandResponse

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Wed Mar 28 10:54:31 EDT 2018")
@AdmGenerated(compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.265 (build 0)",
              date="3/28/18 10:54 AM",
              buildInfo="nvx-talon-3.7.265 (nvx-codegen-plugin)")
public interface ISrvMonInvokeCommandResponse
extends IRogNode, IRogMessage, IRogCopyableNode<ISrvMonInvokeCommandResponse>

Response to a command invocation.

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

void	clearBooleanReturnValue() Clears the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
void	clearByteReturnValue() Clears the value of 'byteReturnValue' Field Description The value for a BYTE return type.
void	clearCharReturnValue() Clears the value of 'charReturnValue' Field Description The value for a CHAR return type.
void	clearDateReturnValue() Clears the value of 'dateReturnValue' Field Description The value for a DATE return type.
void	clearDoubleReturnValue() Clears the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
void	clearErrorMessage() Clears the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
void	clearFloatReturnValue() Clears the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
void	clearIntReturnValue() Clears the value of 'intReturnValue' Field Description The value for a INT return type.
void	clearLongReturnValue() Clears the value of 'longReturnValue' Field Description The value for a LONG return type.
void	clearReturnType() Clears the value of 'returnType' Field Description The response type.
void	clearShortReturnValue() Clears the value of 'shortReturnValue' Field Description The value for a SHORT return type.
void	clearStackTrace() Clears the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
void	clearStringReturnValue() Clears the value of 'stringReturnValue' Field Description The value for a STRING return type.
SrvMonInvokeCommandResponse	copy() Creates a copy of this SrvMonInvokeCommandResponse.
void	copyInto(SrvMonInvokeCommandResponse target) Copies the contents of this SrvMonInvokeCommandResponse into the target.
boolean	getBooleanReturnValue() Gets the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
byte	getByteReturnValue() Gets the value of 'byteReturnValue' Field Description The value for a BYTE return type.
char	getCharReturnValue() Gets the value of 'charReturnValue' Field Description The value for a CHAR return type.
Date	getDateReturnValue() Gets the value of 'dateReturnValue' Field Description The value for a DATE return type.
long	getDateReturnValueAsTimestamp() Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).
double	getDoubleReturnValue() Gets the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
String	getErrorMessage() Gets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
<T extends XString> T	getErrorMessageTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getErrorMessageTo(XString val) Copies the value of 'errorMessage' into the provided XString.
XString	getErrorMessageUnsafe() Gets the raw value of 'errorMessage'.
float	getFloatReturnValue() Gets the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
int	getIntReturnValue() Gets the value of 'intReturnValue' Field Description The value for a INT return type.
long	getLongReturnValue() Gets the value of 'longReturnValue' Field Description The value for a LONG return type.
SrvMonReturnType	getReturnType() Gets the value of 'returnType' Field Description The response type.
short	getShortReturnValue() Gets the value of 'shortReturnValue' Field Description The value for a SHORT return type.
String	getStackTrace() Gets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
<T extends XString> T	getStackTraceTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStackTraceTo(XString val) Copies the value of 'stackTrace' into the provided XString.
XString	getStackTraceUnsafe() Gets the raw value of 'stackTrace'.
String	getStringReturnValue() Gets the value of 'stringReturnValue' Field Description The value for a STRING return type.
<T extends XString> T	getStringReturnValueTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getStringReturnValueTo(XString val) Copies the value of 'stringReturnValue' into the provided XString.
XString	getStringReturnValueUnsafe() Gets the raw value of 'stringReturnValue'.
boolean	hasBooleanReturnValue() Checks for the presence of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
boolean	hasByteReturnValue() Checks for the presence of 'byteReturnValue' Field Description The value for a BYTE return type.
boolean	hasCharReturnValue() Checks for the presence of 'charReturnValue' Field Description The value for a CHAR return type.
boolean	hasDateReturnValue() Checks for the presence of 'dateReturnValue' Field Description The value for a DATE return type.
boolean	hasDoubleReturnValue() Checks for the presence of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
boolean	hasErrorMessage() Checks for the presence of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
boolean	hasFloatReturnValue() Checks for the presence of 'floatReturnValue' Field Description The value for a FLOAT return type.
boolean	hasIntReturnValue() Checks for the presence of 'intReturnValue' Field Description The value for a INT return type.
boolean	hasLongReturnValue() Checks for the presence of 'longReturnValue' Field Description The value for a LONG return type.
boolean	hasReturnType() Checks for the presence of 'returnType' Field Description The response type.
boolean	hasShortReturnValue() Checks for the presence of 'shortReturnValue' Field Description The value for a SHORT return type.
boolean	hasStackTrace() Checks for the presence of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
boolean	hasStringReturnValue() Checks for the presence of 'stringReturnValue' Field Description The value for a STRING return type.
void	lendErrorMessage(XString val) Sets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
void	lendStackTrace(XString val) Sets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
void	lendStringReturnValue(XString val) Sets the value of 'stringReturnValue' Field Description The value for a STRING return type.
void	setBooleanReturnValue(boolean val) Sets the value of 'booleanReturnValue' Field Description The value for a BOOLEAN return type.
void	setByteReturnValue(byte val) Sets the value of 'byteReturnValue' Field Description The value for a BYTE return type.
void	setCharReturnValue(char val) Sets the value of 'charReturnValue' Field Description The value for a CHAR return type.
void	setDateReturnValue(Date val) Sets the value of 'dateReturnValue' Field Description The value for a DATE return type.
void	setDateReturnValueAsTimestamp(long val) Sets the date value as a timestamp.
void	setDoubleReturnValue(double val) Sets the value of 'doubleReturnValue' Field Description The value for a DOUBLE return type.
void	setErrorMessage(String val) Sets the value of 'errorMessage' Field Description If the command did not complete successfully this field holds an error message.
void	setErrorMessageFrom(long val) Sets the value of this String field to the given numeric value.
void	setErrorMessageFrom(XString val) Copies the provided XString value into this object's 'errorMessage'.
void	setFloatReturnValue(float val) Sets the value of 'floatReturnValue' Field Description The value for a FLOAT return type.
void	setIntReturnValue(int val) Sets the value of 'intReturnValue' Field Description The value for a INT return type.
void	setLongReturnValue(long val) Sets the value of 'longReturnValue' Field Description The value for a LONG return type.
void	setReturnType(SrvMonReturnType val) Sets the value of 'returnType' Field Description The response type.
void	setShortReturnValue(short val) Sets the value of 'shortReturnValue' Field Description The value for a SHORT return type.
void	setStackTrace(String val) Sets the value of 'stackTrace' Field Description A stack trace that can accompany an error message if there was an exception
void	setStackTraceFrom(long val) Sets the value of this String field to the given numeric value.
void	setStackTraceFrom(XString val) Copies the provided XString value into this object's 'stackTrace'.
void	setStringReturnValue(String val) Sets the value of 'stringReturnValue' Field Description The value for a STRING return type.
void	setStringReturnValueFrom(long val) Sets the value of this String field to the given numeric value.
void	setStringReturnValueFrom(XString val) Copies the provided XString value into this object's 'stringReturnValue'.

Methods inherited from interface com.neeve.rog.IRogNode

deserializeFromProtobuf, dispose, dump, getAttachment, 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, ensureId, getBinding, getCheckpointVersion, getContentEncodingType, getId, getOfid, getOwnershipCount, getSerializedMetadataLength, getStableTransactionId, getTransactionId, serialize, serializeMetadata, setBinding, setCheckpointVersion, setFieldValue, 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, getOutMsgsInTransaction, getOutTs, getOutTsMicros, getParentId, getPreProcessingTs, getPreProcessingTsMicros, getTransactionInSequenceNumber, getTransactionOutSequenceNumber, isPossibleDuplicate, metadataToJsonString, metadataToString

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setReturnType

void setReturnType(SrvMonReturnType val)

Sets the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Parameters:

val - The value to set.

getReturnType

SrvMonReturnType getReturnType()

Gets the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

Returns:

The response type.

clearReturnType

void clearReturnType()

Clears the value of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

See Also:

setReturnType(SrvMonReturnType)

hasReturnType

boolean hasReturnType()

Checks for the presence of 'returnType'

Field Description

The response type.

This field can be used by callers to determine which return value method to call to get the return value. If the returnType is listed as VOID or the return value is not set it means that the invocation did not return a value.

See Also:

getReturnType()

setBooleanReturnValue

void setBooleanReturnValue(boolean val)

Sets the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Parameters:

val - The value to set.

getBooleanReturnValue

boolean getBooleanReturnValue()

Gets the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

Returns:

The value for a BOOLEAN return type.

clearBooleanReturnValue

void clearBooleanReturnValue()

Clears the value of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

See Also:

setBooleanReturnValue(boolean)

hasBooleanReturnValue

boolean hasBooleanReturnValue()

Checks for the presence of 'booleanReturnValue'

Field Description

The value for a BOOLEAN return type.

See Also:

getBooleanReturnValue()

setByteReturnValue

void setByteReturnValue(byte val)

Sets the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Parameters:

val - The value to set.

getByteReturnValue

byte getByteReturnValue()

Gets the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

Returns:

The value for a BYTE return type.

clearByteReturnValue

void clearByteReturnValue()

Clears the value of 'byteReturnValue'

Field Description

The value for a BYTE return type.

See Also:

setByteReturnValue(byte)

hasByteReturnValue

boolean hasByteReturnValue()

Checks for the presence of 'byteReturnValue'

Field Description

The value for a BYTE return type.

See Also:

getByteReturnValue()

setCharReturnValue

void setCharReturnValue(char val)

Sets the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

Parameters:

val - The value to set.

getCharReturnValue

char getCharReturnValue()

Gets the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

Returns:

The value for a CHAR return type.

clearCharReturnValue

void clearCharReturnValue()

Clears the value of 'charReturnValue'

Field Description

The value for a CHAR return type.

See Also:

setCharReturnValue(char)

hasCharReturnValue

boolean hasCharReturnValue()

Checks for the presence of 'charReturnValue'

Field Description

The value for a CHAR return type.

See Also:

getCharReturnValue()

setShortReturnValue

void setShortReturnValue(short val)

Sets the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Parameters:

val - The value to set.

getShortReturnValue

short getShortReturnValue()

Gets the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

Returns:

The value for a SHORT return type.

clearShortReturnValue

void clearShortReturnValue()

Clears the value of 'shortReturnValue'

Field Description

The value for a SHORT return type.

See Also:

setShortReturnValue(short)

hasShortReturnValue

boolean hasShortReturnValue()

Checks for the presence of 'shortReturnValue'

Field Description

The value for a SHORT return type.

See Also:

getShortReturnValue()

setIntReturnValue

void setIntReturnValue(int val)

Sets the value of 'intReturnValue'

Field Description

The value for a INT return type.

Parameters:

val - The value to set.

getIntReturnValue

int getIntReturnValue()

Gets the value of 'intReturnValue'

Field Description

The value for a INT return type.

Returns:

The value for a INT return type.

clearIntReturnValue

void clearIntReturnValue()

Clears the value of 'intReturnValue'

Field Description

The value for a INT return type.

See Also:

setIntReturnValue(int)

hasIntReturnValue

boolean hasIntReturnValue()

Checks for the presence of 'intReturnValue'

Field Description

The value for a INT return type.

See Also:

getIntReturnValue()

setLongReturnValue

void setLongReturnValue(long val)

Sets the value of 'longReturnValue'

Field Description

The value for a LONG return type.

Parameters:

val - The value to set.

getLongReturnValue

long getLongReturnValue()

Gets the value of 'longReturnValue'

Field Description

The value for a LONG return type.

Returns:

The value for a LONG return type.

clearLongReturnValue

void clearLongReturnValue()

Clears the value of 'longReturnValue'

Field Description

The value for a LONG return type.

See Also:

setLongReturnValue(long)

hasLongReturnValue

boolean hasLongReturnValue()

Checks for the presence of 'longReturnValue'

Field Description

The value for a LONG return type.

See Also:

getLongReturnValue()

setFloatReturnValue

void setFloatReturnValue(float val)

Sets the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Parameters:

val - The value to set.

getFloatReturnValue

float getFloatReturnValue()

Gets the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

Returns:

The value for a FLOAT return type.

clearFloatReturnValue

void clearFloatReturnValue()

Clears the value of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

See Also:

setFloatReturnValue(float)

hasFloatReturnValue

boolean hasFloatReturnValue()

Checks for the presence of 'floatReturnValue'

Field Description

The value for a FLOAT return type.

See Also:

getFloatReturnValue()

setDoubleReturnValue

void setDoubleReturnValue(double val)

Sets the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Parameters:

val - The value to set.

getDoubleReturnValue

double getDoubleReturnValue()

Gets the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

Returns:

The value for a DOUBLE return type.

clearDoubleReturnValue

void clearDoubleReturnValue()

Clears the value of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

See Also:

setDoubleReturnValue(double)

hasDoubleReturnValue

boolean hasDoubleReturnValue()

Checks for the presence of 'doubleReturnValue'

Field Description

The value for a DOUBLE return type.

See Also:

getDoubleReturnValue()

setDateReturnValue

void setDateReturnValue(Date val)

Sets the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

Parameters:

val - The value to set.

getDateReturnValue

Date getDateReturnValue()

Gets the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

Returns:

The value for a DATE return type.

setDateReturnValueAsTimestamp

void setDateReturnValueAsTimestamp(long val)

Sets the date value as a timestamp.

Field Description

The value for a DATE return type.

Parameters:

val - The date value in milliseconds from the epoch

getDateReturnValueAsTimestamp

long getDateReturnValueAsTimestamp()

Retrieves the date as a timestamp (a zero garbage operation for XBuf encoding).

Field Description

The value for a DATE return type.

NOTE:
Note that a return value of -1 could also indicate 1 millisecond before the epoch. In cases where a such an ambiguity is a practical concern, hasDateReturnValue() should be called.

Returns:

The data as a timestamp in milliseconds from the epoch or -1 if null or not set

clearDateReturnValue

void clearDateReturnValue()

Clears the value of 'dateReturnValue'

Field Description

The value for a DATE return type.

See Also:

setDateReturnValue(Date)

hasDateReturnValue

boolean hasDateReturnValue()

Checks for the presence of 'dateReturnValue'

Field Description

The value for a DATE return type.

See Also:

getDateReturnValue()

setStringReturnValue

void setStringReturnValue(String val)

Sets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Parameters:

val - The value to set.

getStringReturnValue

String getStringReturnValue()

Gets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Returns:

The value for a STRING return type.

lendStringReturnValue

void lendStringReturnValue(XString val)

Sets the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

Parameters:

val - The value to set.

setStringReturnValueFrom

void setStringReturnValueFrom(long val)

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

Field Description

The value for a STRING return type.

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

getStringReturnValueTo

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

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

Field Description

The value for a STRING return type.

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

setStringReturnValueFrom

void setStringReturnValueFrom(XString val)

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

Field Description

The value for a STRING return type.

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

getStringReturnValueTo

void getStringReturnValueTo(XString val)

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

Field Description

The value for a STRING return type.

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

See Also:

getStringReturnValue()

getStringReturnValueUnsafe

XString getStringReturnValueUnsafe()

Gets the raw value of 'stringReturnValue'.

Field Description

The value for a STRING return type.

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:

getStringReturnValue()

clearStringReturnValue

void clearStringReturnValue()

Clears the value of 'stringReturnValue'

Field Description

The value for a STRING return type.

See Also:

setStringReturnValue(String)

hasStringReturnValue

boolean hasStringReturnValue()

Checks for the presence of 'stringReturnValue'

Field Description

The value for a STRING return type.

See Also:

getStringReturnValue()

setErrorMessage

void setErrorMessage(String val)

Sets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Parameters:

val - The value to set.

getErrorMessage

String getErrorMessage()

Gets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Returns:

If the command did not complete successfully this field holds an error message.

lendErrorMessage

void lendErrorMessage(XString val)

Sets the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

Parameters:

val - The value to set.

setErrorMessageFrom

void setErrorMessageFrom(long val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

getErrorMessageTo

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

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

Field Description

If the command did not complete successfully this field holds an error message.

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

setErrorMessageFrom

void setErrorMessageFrom(XString val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

getErrorMessageTo

void getErrorMessageTo(XString val)

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

Field Description

If the command did not complete successfully this field holds an error message.

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

See Also:

getErrorMessage()

getErrorMessageUnsafe

XString getErrorMessageUnsafe()

Gets the raw value of 'errorMessage'.

Field Description

If the command did not complete successfully this field holds an error message.

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:

getErrorMessage()

clearErrorMessage

void clearErrorMessage()

Clears the value of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

See Also:

setErrorMessage(String)

hasErrorMessage

boolean hasErrorMessage()

Checks for the presence of 'errorMessage'

Field Description

If the command did not complete successfully this field holds an error message.

See Also:

getErrorMessage()

setStackTrace

void setStackTrace(String val)

Sets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Parameters:

val - The value to set.

getStackTrace

String getStackTrace()

Gets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Returns:

A stack trace that can accompany an error message if there was an exception

lendStackTrace

void lendStackTrace(XString val)

Sets the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

Parameters:

val - The value to set.

setStackTraceFrom

void setStackTraceFrom(long val)

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

Field Description

A stack trace that can accompany an error message if there was an exception

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

getStackTraceTo

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

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

Field Description

A stack trace that can accompany an error message if there was an exception

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

setStackTraceFrom

void setStackTraceFrom(XString val)

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

Field Description

A stack trace that can accompany an error message if there was an exception

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

getStackTraceTo

void getStackTraceTo(XString val)

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

Field Description

A stack trace that can accompany an error message if there was an exception

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

See Also:

getStackTrace()

getStackTraceUnsafe

XString getStackTraceUnsafe()

Gets the raw value of 'stackTrace'.

Field Description

A stack trace that can accompany an error message if there was an exception

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:

getStackTrace()

clearStackTrace

void clearStackTrace()

Clears the value of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

See Also:

setStackTrace(String)

hasStackTrace

boolean hasStackTrace()

Checks for the presence of 'stackTrace'

Field Description

A stack trace that can accompany an error message if there was an exception

See Also:

getStackTrace()

copy

SrvMonInvokeCommandResponse copy()

Creates a copy of this SrvMonInvokeCommandResponse.

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

The returned copy will be writeable even if this SrvMonInvokeCommandResponse 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<ISrvMonInvokeCommandResponse>

Specified by:

copy in interface IRogCopyableNode<ISrvMonInvokeCommandResponse>

Returns:

A copy of this SrvMonInvokeCommandResponse.

See Also:

IRogCopyableNode, CopyableMessageView

copyInto

void copyInto(SrvMonInvokeCommandResponse target)

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

The returned copy will be writeable even if this SrvMonInvokeCommandResponse 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.