@Generated(value="com.neeve.adm.AdmXbufGenerator", date="Fri Dec 05 13:32:50 UTC 2025") @AdmGenerated(encoding="Xbuf", compatLevel="4.1.0", admVersion="Unknown Version", date="12/5/25 1:32 PM", buildInfo="nvx-talon-3.16.63 (nvx-codegen-plugin)") @AdmFactoryInfo(factoryClass=SrvMonCncFactory.class, vfid=36, ofid=36, typeId=300) public final class SrvMonCommandDescription extends Object implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonCommandDescription>, ISrvMonCommandDescription
| ADM Type | Embedded Entity |
| Factory | SrvMonCncFactory |
| ADM Field Summary |
|---|
| Field | Type | Id | Description |
|---|---|---|---|
| additionalArgs | Boolean | 21 | Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs). |
| additionalArgsDescription | String | 24 | The description that describes how additional arguments should be specified. |
| additionalArgsDisplayName | String | 25 | The display name to user for additional arguments. |
| aliases | String[] | 17 | The command alias. |
| arguments | SrvMonArgumentDescription[] | 19 | The available arguments to the command. |
| description | String | 18 | The command description. |
| displayName | String | 23 |
The display name for the command.
If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command. |
| group | String[] | 26 | The group hierarchy this command belongs to. |
| hidden | Boolean | 27 | Whether or not the command is hidden/internal. |
| name | String | 16 | The command name. |
| options | SrvMonOptionDescription[] | 20 | The command options. |
| returnType | SrvMonReturnType |
22 | The return type of this command. |
| Modifier and Type | Class and Description |
|---|---|
static class |
SrvMonCommandDescription.Field
The SrvMonCommandDescription xbuf field (used internally when this entity is used as a field of another entity).
|
static class |
SrvMonCommandDescription.ListField
The SrvMonCommandDescription list field (used internally when this entity is used as an array field of another entity).
|
| Modifier and Type | Field and Description |
|---|---|
static SrvMonCommandDescription[] |
EMPTY_ARRAY
A preallocated empty array used to avoid garbage when returning empty arrays of this type.
|
| Constructor and Description |
|---|
SrvMonCommandDescription() |
SrvMonCommandDescription(int initialBackingBufferSize) |
| Modifier and Type | Method and Description |
|---|---|
SrvMonCommandDescription |
acquire() |
void |
addAliases(String val)
Adds the provided value to the list of 'aliases' values.
|
void |
addArguments(SrvMonArgumentDescription val)
Adds the provided value to the list of 'arguments' values.
|
void |
addGroup(String val)
Adds the provided value to the list of 'group' values.
|
void |
addOptions(SrvMonOptionDescription val)
Adds the provided value to the list of 'options' values.
|
void |
clearAdditionalArgs()
Clears the value of 'additionalArgs'.
|
void |
clearAdditionalArgsDescription()
Clears the value of 'additionalArgsDescription'.
|
void |
clearAdditionalArgsDisplayName()
Clears the value of 'additionalArgsDisplayName'.
|
void |
clearAliases()
Clears the value of 'aliases'.
|
void |
clearArguments()
Clears the value of 'arguments'.
|
void |
clearContent() |
void |
clearDescription()
Clears the value of 'description'.
|
void |
clearDisplayName()
Clears the value of 'displayName'.
|
void |
clearGroup()
Clears the value of 'group'.
|
void |
clearHidden()
Clears the value of 'hidden'.
|
void |
clearName()
Clears the value of 'name'.
|
void |
clearOptions()
Clears the value of 'options'.
|
void |
clearReturnType()
Clears the value of 'returnType'.
|
void |
clearXRogType() |
Object |
clone()
Creates a clone of this object.
|
SrvMonCommandDescription |
copy()
Creates a copy of this SrvMonCommandDescription.
|
void |
copyInto(SrvMonCommandDescription copy)
Copies the contents of this SrvMonCommandDescription into the target.
|
static SrvMonCommandDescription |
create() |
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer |
createAliasesFieldBuffer(int initialBufferLength,
boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk
copy from an XIterator returned for this field.
|
static SrvMonCommandDescription |
createFrom(byte[] serializedContainer) |
static SrvMonCommandDescription |
createFrom(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static SrvMonCommandDescription |
createFromSerializedXbufContainer(byte[] serializedContainer) |
static SrvMonCommandDescription |
createFromSerializedXbufContainer(byte[] serializedContainer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer |
createGroupFieldBuffer(int initialBufferLength,
boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk
copy from an XIterator returned for this field.
|
static com.neeve.xbuf.XbufSchema |
createSchema() |
SrvMonCommandDescription |
deserializeFromByteArray(byte[] array) |
SrvMonCommandDescription |
deserializeFromByteArray(byte[] array,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonCommandDescription |
deserializeFromByteBuffer(ByteBuffer buffer) |
SrvMonCommandDescription |
deserializeFromByteBuffer(ByteBuffer buffer,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonCommandDescription |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length) |
SrvMonCommandDescription |
deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
int offset,
int length,
com.neeve.xbuf.XbufDesyncPolicy desyncPolicy) |
SrvMonCommandDescription |
deserializeFromNative(long address,
int offset,
int length) |
SrvMonCommandDescription |
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() |
boolean |
getAdditionalArgs()
Gets the value of 'additionalArgs'.
|
Boolean |
getAdditionalArgsAsObject()
Gets the value of 'additionalArgs'.
|
String |
getAdditionalArgsDescription()
Gets the value of 'additionalArgsDescription'.
|
com.neeve.xbuf.XbufStringField |
getAdditionalArgsDescriptionField() |
static int |
getAdditionalArgsDescriptionFieldId() |
<T extends XString> |
getAdditionalArgsDescriptionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getAdditionalArgsDescriptionTo(XString val)
Copies the value of 'additionalArgsDescription' into the provided XString.
|
XString |
getAdditionalArgsDescriptionUnsafe()
Gets the raw value of 'additionalArgsDescription'.
|
String |
getAdditionalArgsDisplayName()
Gets the value of 'additionalArgsDisplayName'.
|
com.neeve.xbuf.XbufStringField |
getAdditionalArgsDisplayNameField() |
static int |
getAdditionalArgsDisplayNameFieldId() |
<T extends XString> |
getAdditionalArgsDisplayNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getAdditionalArgsDisplayNameTo(XString val)
Copies the value of 'additionalArgsDisplayName' into the provided XString.
|
XString |
getAdditionalArgsDisplayNameUnsafe()
Gets the raw value of 'additionalArgsDisplayName'.
|
com.neeve.xbuf.XbufVariableBooleanField |
getAdditionalArgsField() |
static int |
getAdditionalArgsFieldId() |
String[] |
getAliases()
Gets the value of 'aliases'.
|
String[] |
getAliasesEmptyIfNull()
Gets the value of 'aliases' or an empty array if the value is
null or not set. |
static int |
getAliasesFieldId() |
XStringIterator |
getAliasesIterator()
Gets the value of 'aliases' as iterator of values.
|
SrvMonArgumentDescription[] |
getArguments()
Gets the value of 'arguments'.
|
SrvMonArgumentDescription[] |
getArgumentsEmptyIfNull()
Gets the value of 'arguments' or an empty array if the value is
null or not set. |
static int |
getArgumentsFieldId() |
XIterator<SrvMonArgumentDescription> |
getArgumentsIterator()
Gets the value of 'arguments' as iterator of values.
|
PktBuffer |
getBackingBuffer() |
String |
getDescription()
Gets the value of 'description'.
|
com.neeve.xbuf.XbufStringField |
getDescriptionField() |
static int |
getDescriptionFieldId() |
<T extends XString> |
getDescriptionTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getDescriptionTo(XString val)
Copies the value of 'description' into the provided XString.
|
XString |
getDescriptionUnsafe()
Gets the raw value of 'description'.
|
static com.neeve.xbuf.XbufDesyncPolicy |
getDesyncPolicy() |
String |
getDisplayName()
Gets the value of 'displayName'.
|
com.neeve.xbuf.XbufStringField |
getDisplayNameField() |
static int |
getDisplayNameFieldId() |
<T extends XString> |
getDisplayNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getDisplayNameTo(XString val)
Copies the value of 'displayName' into the provided XString.
|
XString |
getDisplayNameUnsafe()
Gets the raw value of 'displayName'.
|
String[] |
getGroup()
Gets the value of 'group'.
|
String[] |
getGroupEmptyIfNull()
Gets the value of 'group' or an empty array if the value is
null or not set. |
static int |
getGroupFieldId() |
XStringIterator |
getGroupIterator()
Gets the value of 'group' as iterator of values.
|
boolean |
getHidden()
Gets the value of 'hidden'.
|
Boolean |
getHiddenAsObject()
Gets the value of 'hidden'.
|
com.neeve.xbuf.XbufVariableBooleanField |
getHiddenField() |
static int |
getHiddenFieldId() |
boolean |
getIsReadOnly() |
String |
getName()
Gets the value of 'name'.
|
com.neeve.xbuf.XbufStringField |
getNameField() |
static int |
getNameFieldId() |
<T extends XString> |
getNameTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory.
|
void |
getNameTo(XString val)
Copies the value of 'name' into the provided XString.
|
XString |
getNameUnsafe()
Gets the raw value of 'name'.
|
SrvMonOptionDescription[] |
getOptions()
Gets the value of 'options'.
|
SrvMonOptionDescription[] |
getOptionsEmptyIfNull()
Gets the value of 'options' or an empty array if the value is
null or not set. |
static int |
getOptionsFieldId() |
XIterator<SrvMonOptionDescription> |
getOptionsIterator()
Gets the value of 'options' as iterator of values.
|
int |
getOwnerCount() |
UtlPool<SrvMonCommandDescription> |
getPool()
Get a pool item's pool.
|
SrvMonReturnType |
getReturnType()
Gets the value of 'returnType'.
|
com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> |
getReturnTypeField() |
static int |
getReturnTypeFieldId() |
int |
getSerializeToNativeLength() |
void |
getValidationErrors(List<XString> results,
String errorPrefix)
Collects validation errors into the provided list.
|
short |
getXRogType() |
Short |
getXRogTypeAsObject() |
com.neeve.xbuf.XbufVariableShortField |
getXRogTypeField() |
static int |
getXRogTypeFieldId() |
boolean |
hasAdditionalArgs()
Checks for the presence of 'additionalArgs'.
|
boolean |
hasAdditionalArgsDescription()
Checks for the presence of 'additionalArgsDescription'.
|
boolean |
hasAdditionalArgsDisplayName()
Checks for the presence of 'additionalArgsDisplayName'.
|
boolean |
hasDescription()
Checks for the presence of 'description'.
|
boolean |
hasDisplayName()
Checks for the presence of 'displayName'.
|
boolean |
hasHidden()
Checks for the presence of 'hidden'.
|
boolean |
hasName()
Checks for the presence of 'name'.
|
boolean |
hasReturnType()
Checks for the presence of 'returnType'.
|
boolean |
hasXRogType() |
SrvMonCommandDescription |
init()
Initialize an item.
|
boolean |
isBufferBacked() |
boolean |
isDirty() |
boolean |
isReferenceCounted() |
boolean |
isValid()
Tests if this object has any validation errors.
|
void |
lendAdditionalArgsDescription(XString val)
Lends the value of 'additionalArgsDescription' to this object.
|
void |
lendAdditionalArgsDisplayName(XString val)
Lends the value of 'additionalArgsDisplayName' to this object.
|
void |
lendArguments(SrvMonArgumentDescription val)
Adds the provided value to the list of 'arguments' values and acquires a reference to it.
|
void |
lendArguments(SrvMonArgumentDescription[] val)
Lends the value of 'arguments'.
|
void |
lendArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
Sets the value of 'arguments' by lending the values from the provided iterator.
|
void |
lendDescription(XString val)
Lends the value of 'description' to this object.
|
void |
lendDisplayName(XString val)
Lends the value of 'displayName' to this object.
|
void |
lendName(XString val)
Lends the value of 'name' to this object.
|
void |
lendOptions(SrvMonOptionDescription val)
Adds the provided value to the list of 'options' values and acquires a reference to it.
|
void |
lendOptions(SrvMonOptionDescription[] val)
Lends the value of 'options'.
|
void |
lendOptionsFrom(XIterator<SrvMonOptionDescription> val)
Sets the value of 'options' by lending the values from the provided iterator.
|
static void |
optimizeFor(int val) |
byte[] |
serializeToByteArray() |
ByteBuffer |
serializeToByteBuffer() |
com.neeve.io.IOBuffer |
serializeToIOBuffer(boolean useNative) |
int |
serializeToNative(long address,
int addressOffset) |
void |
setAdditionalArgs(boolean val)
Sets the value of 'additionalArgs'.
|
void |
setAdditionalArgsAsObject(Boolean val)
Sets the value of 'additionalArgs'.
|
void |
setAdditionalArgsDescription(String val)
Sets the value of 'additionalArgsDescription'.
|
void |
setAdditionalArgsDescriptionFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setAdditionalArgsDescriptionFrom(com.neeve.xbuf.XbufStringField val) |
void |
setAdditionalArgsDescriptionFrom(XString val)
Copies the provided XString value into this object's 'additionalArgsDescription'.
|
void |
setAdditionalArgsDisplayName(String val)
Sets the value of 'additionalArgsDisplayName'.
|
void |
setAdditionalArgsDisplayNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setAdditionalArgsDisplayNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setAdditionalArgsDisplayNameFrom(XString val)
Copies the provided XString value into this object's 'additionalArgsDisplayName'.
|
void |
setAdditionalArgsFrom(com.neeve.xbuf.XbufVariableBooleanField val) |
void |
setAliases(String[] val)
Sets the value of 'aliases'.
|
void |
setAliasesFrom(XIterator<String> val)
Sets the value of 'aliases' using the values from the provided iterator.
|
void |
setArguments(SrvMonArgumentDescription[] val)
Sets the value of 'arguments'.
|
void |
setArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
Sets the value of 'arguments' using the values from the provided iterator.
|
void |
setAsReadOnly() |
void |
setDescription(String val)
Sets the value of 'description'.
|
void |
setDescriptionFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setDescriptionFrom(com.neeve.xbuf.XbufStringField val) |
void |
setDescriptionFrom(XString val)
Copies the provided XString value into this object's 'description'.
|
static void |
setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val) |
void |
setDisplayName(String val)
Sets the value of 'displayName'.
|
void |
setDisplayNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setDisplayNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setDisplayNameFrom(XString val)
Copies the provided XString value into this object's 'displayName'.
|
static void |
setFieldInterest(List<Integer> fieldIds) |
void |
setGroup(String[] val)
Sets the value of 'group'.
|
void |
setGroupFrom(XIterator<String> val)
Sets the value of 'group' using the values from the provided iterator.
|
void |
setHidden(boolean val)
Sets the value of 'hidden'.
|
void |
setHiddenAsObject(Boolean val)
Sets the value of 'hidden'.
|
void |
setHiddenFrom(com.neeve.xbuf.XbufVariableBooleanField val) |
void |
setName(String val)
Sets the value of 'name'.
|
void |
setNameFrom(long val)
Sets the value of this String field to the given numeric value.
|
void |
setNameFrom(com.neeve.xbuf.XbufStringField val) |
void |
setNameFrom(XString val)
Copies the provided XString value into this object's 'name'.
|
void |
setOptions(SrvMonOptionDescription[] val)
Sets the value of 'options'.
|
void |
setOptionsFrom(XIterator<SrvMonOptionDescription> val)
Sets the value of 'options' using the values from the provided iterator.
|
SrvMonCommandDescription |
setPool(UtlPool<SrvMonCommandDescription> pool)
Set a pool item's pool.
|
void |
setPreserializedFields(PktBuffer buffer) |
void |
setReturnType(SrvMonReturnType val)
Sets the value of 'returnType'.
|
void |
setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val) |
void |
setXRogType(short val) |
void |
setXRogTypeAsObject(Short val) |
void |
setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val) |
void |
sync() |
void |
syncFieldBitmask() |
SrvMonArgumentDescription[] |
takeArguments()
Takes the value of 'arguments'.
|
SrvMonOptionDescription[] |
takeOptions()
Takes the value of 'options'.
|
String |
toString() |
public static final SrvMonCommandDescription[] EMPTY_ARRAY
public SrvMonCommandDescription()
public SrvMonCommandDescription(int initialBackingBufferSize)
public static SrvMonCommandDescription create()
public static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer)
public static SrvMonCommandDescription createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public static SrvMonCommandDescription createFrom(byte[] serializedContainer)
public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
public final void clearContent()
public final void syncFieldBitmask()
public final void desyncFieldBitmask()
public final PktBuffer getBackingBuffer()
public static final void optimizeFor(int val)
public final void setAsReadOnly()
public final boolean getIsReadOnly()
public final void setPreserializedFields(PktBuffer buffer)
public static final int getXRogTypeFieldId()
public final void setXRogType(short val)
public final void setXRogTypeAsObject(Short val)
public final short getXRogType()
public final Short getXRogTypeAsObject()
public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
public final boolean hasXRogType()
public final void clearXRogType()
public static final int getAdditionalArgsFieldId()
public final void setAdditionalArgs(boolean val)
ISrvMonCommandDescriptionsetAdditionalArgs in interface ISrvMonCommandDescriptionval - The value to set.public final void setAdditionalArgsAsObject(Boolean val)
ISrvMonCommandDescriptionsetAdditionalArgsAsObject in interface ISrvMonCommandDescriptionval - The value to set.public final boolean getAdditionalArgs()
ISrvMonCommandDescriptiongetAdditionalArgs in interface ISrvMonCommandDescriptionpublic final Boolean getAdditionalArgsAsObject()
ISrvMonCommandDescriptiongetAdditionalArgsAsObject in interface ISrvMonCommandDescriptionpublic final void setAdditionalArgsFrom(com.neeve.xbuf.XbufVariableBooleanField val)
public final com.neeve.xbuf.XbufVariableBooleanField getAdditionalArgsField()
public final boolean hasAdditionalArgs()
ISrvMonCommandDescriptionhasAdditionalArgs in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgs()public final void clearAdditionalArgs()
ISrvMonCommandDescriptionclearAdditionalArgs in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setAdditionalArgs(boolean)public static final int getReturnTypeFieldId()
public final void setReturnType(SrvMonReturnType val)
ISrvMonCommandDescriptionsetReturnType in interface ISrvMonCommandDescriptionval - The value to set.public final void setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val)
public final com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> getReturnTypeField()
public final SrvMonReturnType getReturnType()
ISrvMonCommandDescriptiongetReturnType in interface ISrvMonCommandDescriptionpublic final boolean hasReturnType()
ISrvMonCommandDescriptionhasReturnType in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getReturnType()public final void clearReturnType()
ISrvMonCommandDescriptionclearReturnType in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setReturnType(SrvMonReturnType)public static final int getHiddenFieldId()
public final void setHidden(boolean val)
ISrvMonCommandDescriptionsetHidden in interface ISrvMonCommandDescriptionval - The value to set.public final void setHiddenAsObject(Boolean val)
ISrvMonCommandDescriptionsetHiddenAsObject in interface ISrvMonCommandDescriptionval - The value to set.public final boolean getHidden()
ISrvMonCommandDescriptiongetHidden in interface ISrvMonCommandDescriptionpublic final Boolean getHiddenAsObject()
ISrvMonCommandDescriptiongetHiddenAsObject in interface ISrvMonCommandDescriptionpublic final void setHiddenFrom(com.neeve.xbuf.XbufVariableBooleanField val)
public final com.neeve.xbuf.XbufVariableBooleanField getHiddenField()
public final boolean hasHidden()
ISrvMonCommandDescriptionhasHidden in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getHidden()public final void clearHidden()
ISrvMonCommandDescriptionclearHidden in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setHidden(boolean)public static final int getNameFieldId()
public final void setName(String val)
ISrvMonCommandDescriptionsetName in interface ISrvMonCommandDescriptionval - The value to set.public final String getName()
ISrvMonCommandDescriptiongetName in interface ISrvMonCommandDescriptionpublic final void lendName(XString val)
ISrvMonCommandDescriptionThis method is equivalent to setName 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.
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.
lendName in interface ISrvMonCommandDescriptionval - The value to set.public final void setNameFrom(long val)
ISrvMonCommandDescription
NOTE:
This is the same as calling ISrvMonCommandDescription.setName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setNameFrom in interface ISrvMonCommandDescriptionpublic final <T extends XString> T getNameTo(XString.Factory<T> factory)
ISrvMonCommandDescription
If the value of this field is not null this method creates an XString from
the provided Factory, copies this field's value into the type, and returns the new
XString.);
This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
getNameTo in interface ISrvMonCommandDescriptionfactory - The factory from which to get the XString to copy into and returnnull.public final void setNameFrom(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonCommandDescription.setName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setNameFrom in interface ISrvMonCommandDescriptionpublic final void getNameTo(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonCommandDescription.getName() bec
because it can avoid decoding the value into an String.
getNameTo in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getName()public final XString getNameUnsafe()
ISrvMonCommandDescription
NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation
when copying this field value to another object because it avoids copying the data into an intermediate
XString and instead allows direct byte transfer from the raw value to the target object.
However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
getNameUnsafe in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getName()public final void setNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getNameField()
public final boolean hasName()
ISrvMonCommandDescriptionhasName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getName()public final void clearName()
ISrvMonCommandDescriptionclearName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setName(String)public static final int getAliasesFieldId()
public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createAliasesFieldBuffer(int initialBufferLength,
boolean isNative)
For example the following would result in a bulk transfer from this message
XbufRepeatedStringFieldBuffer preallocated = SrvMonCommandDescription.createAliasesFieldBuffer(1024, true); // The following would then result in a buffer copy without any iteration: preallocated.setValue(inboundMessage.getAliasesIterator()); // The preallocated bulk copied values can then be transfered to an outbound message: outboundMessage.setAliases.setValueFrom(preallocated);
Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.
initialBufferLength - the initial size of the underlying backing buffer.isNative - Whether the backing buffer should be a native or heap buffer.public final void setAliases(String[] val)
ISrvMonCommandDescriptionsetAliases in interface ISrvMonCommandDescriptionval - The value to set.public final void setAliasesFrom(XIterator<String> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'aliases' accessor can copy the values without iteration.
NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonCommandDescription.setAliases(String[]) with
a value of null.
setAliasesFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void addAliases(String val)
ISrvMonCommandDescriptionThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'aliases' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
addAliases in interface ISrvMonCommandDescriptionval - the value to add.public final String[] getAliases()
ISrvMonCommandDescription
If the field is not set this method will return null.
getAliases in interface ISrvMonCommandDescriptionnull.public final String[] getAliasesEmptyIfNull()
ISrvMonCommandDescriptionnull or not set.
getAliasesEmptyIfNull in interface ISrvMonCommandDescriptionnull if not set.ISrvMonCommandDescription.getAliases()public final XStringIterator getAliasesIterator()
ISrvMonCommandDescriptionThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method
can perform a direct copy of the underlying values without iteration.
getAliasesIterator in interface ISrvMonCommandDescriptionpublic final void clearAliases()
ISrvMonCommandDescriptionclearAliases in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setAliases(String[])public static final int getDescriptionFieldId()
public final void setDescription(String val)
ISrvMonCommandDescriptionsetDescription in interface ISrvMonCommandDescriptionval - The value to set.public final String getDescription()
ISrvMonCommandDescriptiongetDescription in interface ISrvMonCommandDescriptionpublic final void lendDescription(XString val)
ISrvMonCommandDescriptionThis method is equivalent to setDescription 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.
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.
lendDescription in interface ISrvMonCommandDescriptionval - The value to set.public final void setDescriptionFrom(long val)
ISrvMonCommandDescription
NOTE:
This is the same as calling ISrvMonCommandDescription.setDescription(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDescriptionFrom in interface ISrvMonCommandDescriptionpublic final <T extends XString> T getDescriptionTo(XString.Factory<T> factory)
ISrvMonCommandDescription
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;
getDescriptionTo in interface ISrvMonCommandDescriptionfactory - The factory from which to get the XString to copy into and returnnull.public final void setDescriptionFrom(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonCommandDescription.setDescription(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDescriptionFrom in interface ISrvMonCommandDescriptionpublic final void getDescriptionTo(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonCommandDescription.getDescription() bec
because it can avoid decoding the value into an String.
getDescriptionTo in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDescription()public final XString getDescriptionUnsafe()
ISrvMonCommandDescription
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.
getDescriptionUnsafe in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDescription()public final void setDescriptionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getDescriptionField()
public final boolean hasDescription()
ISrvMonCommandDescriptionhasDescription in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDescription()public final void clearDescription()
ISrvMonCommandDescriptionclearDescription in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setDescription(String)public static final int getArgumentsFieldId()
public final void setArguments(SrvMonArgumentDescription[] val)
ISrvMonCommandDescriptionsetArguments in interface ISrvMonCommandDescriptionval - The value to set.public final void setArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'arguments' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[]) with
a value of null.
setArgumentsFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void lendArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'arguments' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[]) with
a value of null.
lendArgumentsFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void lendArguments(SrvMonArgumentDescription[] val)
ISrvMonCommandDescription
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.
lendArguments in interface ISrvMonCommandDescriptionval - the value to 'lend' to lend.public final void addArguments(SrvMonArgumentDescription val)
ISrvMonCommandDescriptionThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'arguments' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
addArguments in interface ISrvMonCommandDescriptionval - the value to add.public final void lendArguments(SrvMonArgumentDescription val)
ISrvMonCommandDescriptionLending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'arguments' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
lendArguments in interface ISrvMonCommandDescriptionval - the value to add.public final SrvMonArgumentDescription[] getArguments()
ISrvMonCommandDescription
If the field is not set this method will return null.
getArguments in interface ISrvMonCommandDescriptionnull.public final SrvMonArgumentDescription[] getArgumentsEmptyIfNull()
ISrvMonCommandDescriptionnull or not set.
getArgumentsEmptyIfNull in interface ISrvMonCommandDescriptionnull if not set.ISrvMonCommandDescription.getArguments()public final XIterator<SrvMonArgumentDescription> getArgumentsIterator()
ISrvMonCommandDescriptionThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getArgumentsIterator in interface ISrvMonCommandDescriptionpublic final SrvMonArgumentDescription[] takeArguments()
ISrvMonCommandDescription
NOTE:
A nested entity reference returned by ISrvMonCommandDescription.getArguments() 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.
takeArguments in interface ISrvMonCommandDescriptionnull if the field is not set.public final void clearArguments()
ISrvMonCommandDescriptionclearArguments in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[])public static final int getOptionsFieldId()
public final void setOptions(SrvMonOptionDescription[] val)
ISrvMonCommandDescriptionsetOptions in interface ISrvMonCommandDescriptionval - The value to set.public final void setOptionsFrom(XIterator<SrvMonOptionDescription> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'options' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setOptions(SrvMonOptionDescription[]) with
a value of null.
setOptionsFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void lendOptionsFrom(XIterator<SrvMonOptionDescription> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method will acquire references to each non null value in the provided iterator making it suitable for cases where the values come from another message that may be disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'options' accessor can copy the values without iteration.
NOTE:
Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setOptions(SrvMonOptionDescription[]) with
a value of null.
lendOptionsFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void lendOptions(SrvMonOptionDescription[] val)
ISrvMonCommandDescription
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.
lendOptions in interface ISrvMonCommandDescriptionval - the value to 'lend' to lend.public final void addOptions(SrvMonOptionDescription val)
ISrvMonCommandDescriptionThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'options' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
addOptions in interface ISrvMonCommandDescriptionval - the value to add.public final void lendOptions(SrvMonOptionDescription val)
ISrvMonCommandDescriptionLending of an added value is useful in cases where a field is being added from a source message to provide dispose of the source value when the source message is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'options' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
lendOptions in interface ISrvMonCommandDescriptionval - the value to add.public final SrvMonOptionDescription[] getOptions()
ISrvMonCommandDescription
If the field is not set this method will return null.
getOptions in interface ISrvMonCommandDescriptionnull.public final SrvMonOptionDescription[] getOptionsEmptyIfNull()
ISrvMonCommandDescriptionnull or not set.
getOptionsEmptyIfNull in interface ISrvMonCommandDescriptionnull if not set.ISrvMonCommandDescription.getOptions()public final XIterator<SrvMonOptionDescription> getOptionsIterator()
ISrvMonCommandDescriptionThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
The elements returned by this iterator are owned by and pooled along with this object. The caller must call acquire() on each returned object that it intends to keep beyond the either the next call to next(), toFirst() or the lifespace of this object as each object returned by this iterator is disposed on a subsequent call to next() or when this object is disposed.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(XIterator
getOptionsIterator in interface ISrvMonCommandDescriptionpublic final SrvMonOptionDescription[] takeOptions()
ISrvMonCommandDescription
NOTE:
A nested entity reference returned by ISrvMonCommandDescription.getOptions() 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.
takeOptions in interface ISrvMonCommandDescriptionnull if the field is not set.public final void clearOptions()
ISrvMonCommandDescriptionclearOptions in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setOptions(SrvMonOptionDescription[])public static final int getDisplayNameFieldId()
public final void setDisplayName(String val)
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
setDisplayName in interface ISrvMonCommandDescriptionval - The value to set.public final String getDisplayName()
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
getDisplayName in interface ISrvMonCommandDescriptionpublic final void lendDisplayName(XString val)
ISrvMonCommandDescriptionThis method is equivalent to setDisplayName 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.
If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
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.
lendDisplayName in interface ISrvMonCommandDescriptionval - The value to set.public final void setDisplayNameFrom(long val)
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is the same as calling ISrvMonCommandDescription.setDisplayName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setDisplayNameFrom in interface ISrvMonCommandDescriptionpublic final <T extends XString> T getDisplayNameTo(XString.Factory<T> factory)
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
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;
getDisplayNameTo in interface ISrvMonCommandDescriptionfactory - The factory from which to get the XString to copy into and returnnull.public final void setDisplayNameFrom(XString val)
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonCommandDescription.setDisplayName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setDisplayNameFrom in interface ISrvMonCommandDescriptionpublic final void getDisplayNameTo(XString val)
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonCommandDescription.getDisplayName() bec
because it can avoid decoding the value into an String.
getDisplayNameTo in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDisplayName()public final XString getDisplayNameUnsafe()
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
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.
getDisplayNameUnsafe in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDisplayName()public final void setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getDisplayNameField()
public final boolean hasDisplayName()
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
hasDisplayName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getDisplayName()public final void clearDisplayName()
ISrvMonCommandDescriptionIf a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
clearDisplayName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setDisplayName(String)public static final int getAdditionalArgsDescriptionFieldId()
public final void setAdditionalArgsDescription(String val)
ISrvMonCommandDescriptionsetAdditionalArgsDescription in interface ISrvMonCommandDescriptionval - The value to set.public final String getAdditionalArgsDescription()
ISrvMonCommandDescriptiongetAdditionalArgsDescription in interface ISrvMonCommandDescriptionpublic final void lendAdditionalArgsDescription(XString val)
ISrvMonCommandDescriptionThis method is equivalent to setAdditionalArgsDescription 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.
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.
lendAdditionalArgsDescription in interface ISrvMonCommandDescriptionval - The value to set.public final void setAdditionalArgsDescriptionFrom(long val)
ISrvMonCommandDescription
NOTE:
This is the same as calling ISrvMonCommandDescription.setAdditionalArgsDescription(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAdditionalArgsDescriptionFrom in interface ISrvMonCommandDescriptionpublic final <T extends XString> T getAdditionalArgsDescriptionTo(XString.Factory<T> factory)
ISrvMonCommandDescription
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;
getAdditionalArgsDescriptionTo in interface ISrvMonCommandDescriptionfactory - The factory from which to get the XString to copy into and returnnull.public final void setAdditionalArgsDescriptionFrom(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonCommandDescription.setAdditionalArgsDescription(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setAdditionalArgsDescriptionFrom in interface ISrvMonCommandDescriptionpublic final void getAdditionalArgsDescriptionTo(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonCommandDescription.getAdditionalArgsDescription() bec
because it can avoid decoding the value into an String.
getAdditionalArgsDescriptionTo in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDescription()public final XString getAdditionalArgsDescriptionUnsafe()
ISrvMonCommandDescription
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.
getAdditionalArgsDescriptionUnsafe in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDescription()public final void setAdditionalArgsDescriptionFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getAdditionalArgsDescriptionField()
public final boolean hasAdditionalArgsDescription()
ISrvMonCommandDescriptionhasAdditionalArgsDescription in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDescription()public final void clearAdditionalArgsDescription()
ISrvMonCommandDescriptionclearAdditionalArgsDescription in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setAdditionalArgsDescription(String)public static final int getAdditionalArgsDisplayNameFieldId()
public final void setAdditionalArgsDisplayName(String val)
ISrvMonCommandDescriptionsetAdditionalArgsDisplayName in interface ISrvMonCommandDescriptionval - The value to set.public final String getAdditionalArgsDisplayName()
ISrvMonCommandDescriptiongetAdditionalArgsDisplayName in interface ISrvMonCommandDescriptionpublic final void lendAdditionalArgsDisplayName(XString val)
ISrvMonCommandDescriptionThis method is equivalent to setAdditionalArgsDisplayName 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.
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.
lendAdditionalArgsDisplayName in interface ISrvMonCommandDescriptionval - The value to set.public final void setAdditionalArgsDisplayNameFrom(long val)
ISrvMonCommandDescription
NOTE:
This is the same as calling ISrvMonCommandDescription.setAdditionalArgsDisplayName(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
setAdditionalArgsDisplayNameFrom in interface ISrvMonCommandDescriptionpublic final <T extends XString> T getAdditionalArgsDisplayNameTo(XString.Factory<T> factory)
ISrvMonCommandDescription
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;
getAdditionalArgsDisplayNameTo in interface ISrvMonCommandDescriptionfactory - The factory from which to get the XString to copy into and returnnull.public final void setAdditionalArgsDisplayNameFrom(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than ISrvMonCommandDescription.setAdditionalArgsDisplayName(String)
because it avoids encoding the value into a String if the given XString is already encoded.
setAdditionalArgsDisplayNameFrom in interface ISrvMonCommandDescriptionpublic final void getAdditionalArgsDisplayNameTo(XString val)
ISrvMonCommandDescription
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than ISrvMonCommandDescription.getAdditionalArgsDisplayName() bec
because it can avoid decoding the value into an String.
getAdditionalArgsDisplayNameTo in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDisplayName()public final XString getAdditionalArgsDisplayNameUnsafe()
ISrvMonCommandDescription
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.
getAdditionalArgsDisplayNameUnsafe in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDisplayName()public final void setAdditionalArgsDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
public final com.neeve.xbuf.XbufStringField getAdditionalArgsDisplayNameField()
public final boolean hasAdditionalArgsDisplayName()
ISrvMonCommandDescriptionhasAdditionalArgsDisplayName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.getAdditionalArgsDisplayName()public final void clearAdditionalArgsDisplayName()
ISrvMonCommandDescriptionclearAdditionalArgsDisplayName in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setAdditionalArgsDisplayName(String)public static final int getGroupFieldId()
public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createGroupFieldBuffer(int initialBufferLength,
boolean isNative)
For example the following would result in a bulk transfer from this message
XbufRepeatedStringFieldBuffer preallocated = SrvMonCommandDescription.createGroupFieldBuffer(1024, true); // The following would then result in a buffer copy without any iteration: preallocated.setValue(inboundMessage.getGroupIterator()); // The preallocated bulk copied values can then be transfered to an outbound message: outboundMessage.setGroup.setValueFrom(preallocated);
Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.
initialBufferLength - the initial size of the underlying backing buffer.isNative - Whether the backing buffer should be a native or heap buffer.public final void setGroup(String[] val)
ISrvMonCommandDescriptionsetGroup in interface ISrvMonCommandDescriptionval - The value to set.public final void setGroupFrom(XIterator<String> val)
ISrvMonCommandDescription
This method will call XIterator.toFirst() before and after setting the values, meaning
that all values from the iterator will be set and the iterator will be reset on return.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'group' accessor can copy the values without iteration.
NOTE:
Passing a null or empty iterator has the same affect as calling ISrvMonCommandDescription.setGroup(String[]) with
a value of null.
setGroupFrom in interface ISrvMonCommandDescriptionval - the values to set.public final void addGroup(String val)
ISrvMonCommandDescriptionThis method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'group' accessor can copy the values without iteration.
For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.
addGroup in interface ISrvMonCommandDescriptionval - the value to add.public final String[] getGroup()
ISrvMonCommandDescription
If the field is not set this method will return null.
getGroup in interface ISrvMonCommandDescriptionnull.public final String[] getGroupEmptyIfNull()
ISrvMonCommandDescriptionnull or not set.
getGroupEmptyIfNull in interface ISrvMonCommandDescriptionnull if not set.ISrvMonCommandDescription.getGroup()public final XStringIterator getGroupIterator()
ISrvMonCommandDescriptionThis method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.
This method is zero garbage for Xbuf generated classes, and this method is optimized such that
passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method
can perform a direct copy of the underlying values without iteration.
getGroupIterator in interface ISrvMonCommandDescriptionpublic final void clearGroup()
ISrvMonCommandDescriptionclearGroup in interface ISrvMonCommandDescriptionISrvMonCommandDescription.setGroup(String[])public final boolean isDirty()
public static final com.neeve.xbuf.XbufSchema createSchema()
public final byte[] serializeToByteArray()
public final ByteBuffer serializeToByteBuffer()
public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
public final boolean isBufferBacked()
public final int getSerializeToNativeLength()
public final int serializeToNative(long address,
int addressOffset)
public final SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
public final SrvMonCommandDescription deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonCommandDescription deserializeFromByteArray(byte[] array)
public final SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer)
public final SrvMonCommandDescription deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
public final SrvMonCommandDescription deserializeFromNative(long address, int offset, int length)
public final void sync()
public final int desync(PktBuffer buffer, int pos, boolean frameOnly)
com.neeve.xbuf.IXbufDesyncerdesync in interface com.neeve.xbuf.IXbufDesyncerbuffer - The buffer to desync frompos - The position in the container's backing buffer to desync
fromframeOnly - Whether to frame the field on the underlying buffer.
See XbufField.desync(PktBuffer, int, boolean) for more
informationpublic final SrvMonCommandDescription init()
UtlPool.ItemThis method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
init in interface UtlPool.Item<SrvMonCommandDescription>public final SrvMonCommandDescription setPool(UtlPool<SrvMonCommandDescription> pool)
UtlPool.ItemThis method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
setPool in interface UtlPool.Item<SrvMonCommandDescription>public final UtlPool<SrvMonCommandDescription> getPool()
UtlPool.Item
This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
getPool in interface UtlPool.Item<SrvMonCommandDescription>UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)public final boolean isReferenceCounted()
public final SrvMonCommandDescription acquire()
public final int getOwnerCount()
public final void dispose()
public final Object clone()
This method differs from the copy() method in that:
public final SrvMonCommandDescription copy()
The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonCommandDescription's embedded entity fields.
The returned copy will be writeable even if this SrvMonCommandDescription is read only.
public final void copyInto(SrvMonCommandDescription copy)
The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonCommandDescription's embedded entity fields.
The returned copy will be writeable even if this SrvMonCommandDescription is read only.
copy - The target into which to copy.public final boolean isValid()
IRogValidatableisValid in interface IRogValidatablepublic final void getValidationErrors(List<XString> results, String errorPrefix)
IRogValidatablegetValidationErrors in interface IRogValidatableresults - 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.Copyright © 2019 Neeve Research, LLC. All Rights Reserved.