SrvMonCommandDescription (Rumi 4.0.595 API)

java.lang.Object
- com.neeve.server.mon.cnc.SrvMonCommandDescription

All Implemented Interfaces:: AdmRuntime.BufferSizer, com.neeve.query.impl.index.IdxMappable, IRogValidatable, ISrvMonCommandDescription, MessageReflector, UtlPool.Item<SrvMonCommandDescription>

@Generated(value="com.neeve.protobuf.adm.ProtobufAdmNodeGenerator",
           date="Tue Sep 16 04:36:04 UTC 2025")
 @AdmGenerated(encoding="xbuf",
              compatLevel="5.0.0",
              admVersion="Unknown Version",
              date="9/16/25 4:36 AM",
              buildInfo="nvx-rumi-server-4.0.595 (Rumi ADM Maven Plugin)")
 @AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=300)
public final class SrvMonCommandDescription
extends Object
implements ISrvMonCommandDescription, MessageReflector, com.neeve.query.impl.index.IdxMappable, UtlPool.Item<SrvMonCommandDescription>, AdmRuntime.BufferSizer

Describes a command.

ADM Details

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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SrvMonCommandDescription.Deserializer` The deserializer
`static class`	`SrvMonCommandDescription.PacketBody` The backing packet type for SrvMonCommandDescription (used internally for serialization purposes).
`static class`	`SrvMonCommandDescription.Pojo` The POJO
`static class`	`SrvMonCommandDescription.Serializer` The serializer

Field Summary

Fields
Modifier and Type Field and Description

static SrvMonCommandDescription[] EMPTY_ARRAY

Fields
Modifier and Type	Field and Description
`static SrvMonCommandDescription[]`	`EMPTY_ARRAY`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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.
`boolean`	`appendFieldValueTo(Object node, String[] pathComponents, XString target)` Appends a reflected field value as a string into the given XString.
`boolean`	`appendFieldValueTo(Object message, String name, XString target)` Appends a reflected field value as a string into the given XString.
`void`	`clear()`
`void`	`clear(boolean disposeMembers)`
`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()` Deprecated.
`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'.
`Object`	`clone()` Creates a clone of this object.
`SrvMonCommandDescription`	`copy()`
`void`	`copyInto(SrvMonCommandDescription copy)`
`static SrvMonCommandDescription`	`create()`
`SrvMonCommandDescription`	`deserializeFrom(byte[] array, int offset, int len)`
`SrvMonCommandDescription`	`deserializeFrom(ByteBuffer buffer)`
`SrvMonCommandDescription`	`deserializeFrom(IOBuffer buffer, int offset, int len)`
`SrvMonCommandDescription`	`deserializeFrom(IOElasticBuffer buffer, int offset, int len)`
`SrvMonCommandDescription`	`deserializeFrom(long addr, int offset, int len)`
`SrvMonCommandDescription`	`deserializeFrom(PktPacket packet)`
`SrvMonCommandDescription`	`deserializeFrom(SrvMonCommandDescription.Deserializer deserializer)`
`SrvMonCommandDescription`	`deserializeFrom(SrvMonCommandDescription val)`
`SrvMonCommandDescription`	`deserializeFromByteArray(byte[] array)`
`SrvMonCommandDescription`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonCommandDescription`	`deserializeFromJson(String json)`
`SrvMonCommandDescription`	`deserializeFromNative(long addr, int offset, int len)` Deprecated.
`SrvMonCommandDescription`	`deserializeFromPacket(PktPacket packet)`
`SrvMonCommandDescription`	`deserializeFromRawJson(String json)`
`SrvMonCommandDescription.Deserializer`	`deserializer()`
`SrvMonCommandDescription.Deserializer`	`deserializer(boolean createBuffer)`
`void`	`dispose()`
`void`	`disposeDeserializer()`
`void`	`disposePojo()`
`void`	`disposePojo(boolean sync)`
`void`	`disposeSerializedBuffer()`
`void`	`disposeSerializedBuffer(boolean gcDisposed)`
`void`	`disposeSerializer()`
`long`	`ensureCapacity(long addr, int capacity)` Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized
`boolean`	`fieldExists(Object message, String name)` Check if a field of the supplied name exists in a message.
`boolean`	`getAdditionalArgs()` Gets the value of 'additionalArgs'.
`Boolean`	`getAdditionalArgsAsObject()` Gets the value of 'additionalArgs'.
`String`	`getAdditionalArgsDescription()` Gets the value of 'additionalArgsDescription'.
`static int`	`getAdditionalArgsDescriptionFieldId()`
`<T extends XString> T`	`getAdditionalArgsDescriptionTo(IXStringFactory<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'.
`static int`	`getAdditionalArgsDisplayNameFieldId()`
`<T extends XString> T`	`getAdditionalArgsDisplayNameTo(IXStringFactory<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'.
`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`	`getArgumentsAt(int index)` Gets the element of 'arguments' at a specified index.
`int`	`getArgumentsCount()` Gets number of elements in '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.
`String`	`getDescription()` Gets the value of 'description'.
`static int`	`getDescriptionFieldId()`
`<T extends XString> T`	`getDescriptionTo(IXStringFactory<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'.
`String`	`getDisplayName()` Gets the value of 'displayName'.
`static int`	`getDisplayNameFieldId()`
`<T extends XString> T`	`getDisplayNameTo(IXStringFactory<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'.
`static <T> IRogFieldReflector<SrvMonCommandDescription,T>`	`getFieldReflector(String name)` Get a field reflector.
`static <T> IRogFieldReflector<SrvMonCommandDescription,T>`	`getFieldReflector(String[] pathComponents)` Get a field reflector.
`XString`	`getFieldValueAsRawString(Object message, String name)` Get the value of a reflectable field in a message as a string.
`XString`	`getFieldValueAsRawString(Object message, String[] pathComponents)` Get the value of a reflectable field in a message as a string.
`String`	`getFieldValueAsString(Object message, String name)` Get the value of a reflectable field in a message as a string.
`String`	`getFieldValueAsString(Object message, String[] pathComponents)` Get the value of a reflectable field in a message as a string.
`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'.
`static int`	`getHiddenFieldId()`
`String`	`getName()` Gets the value of 'name'.
`static int`	`getNameFieldId()`
`<T extends XString> T`	`getNameTo(IXStringFactory<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`	`getOptionsAt(int index)` Gets the element of 'options' at a specified index.
`int`	`getOptionsCount()` Gets number of elements in '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`	`getOwnershipCount()`
`UtlPool<SrvMonCommandDescription>`	`getPool()` Get a pool item's pool.
`Object`	`getQueryFieldValue(String name)` Gets an indexable value identified by a key.
`SrvMonReturnType`	`getReturnType()` Gets the value of 'returnType'.
`static int`	`getReturnTypeFieldId()`
`long`	`getSerializedBuffer()`
`int`	`getSerializedBufferCapacity()`
`int`	`getSerializedBufferLength()`
`int`	`getSerializeToNativeLength()` Deprecated.
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`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`	`hasDirtyPojo()`
`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`	`hasPojo()`
`boolean`	`hasReturnType()` Checks for the presence of 'returnType'.
`boolean`	`hasSerializedBuffer()`
`SrvMonCommandDescription`	`init()` Initialize an item.
`boolean`	`isFieldReflectable(Object message, String name)` Check if a field of the supplied name is reflectable.
`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.
`boolean`	`needsSync()` Check if a view needs to be sync'd for reflection.
`SrvMonCommandDescription.Pojo`	`pojo()`
`SrvMonCommandDescription.Pojo`	`pojo(boolean onlyPojos)`
`void`	`reset()`
`void`	`reset(boolean disposeMembers)`
`SrvMonCommandDescription.Serializer`	`serializer()`
`SrvMonCommandDescription.Serializer`	`serializer(int minimumLength)`
`SrvMonCommandDescription.Serializer`	`serializer(int length, boolean autoResizeTargetBuffer)`
`int`	`serializeTo(byte[] array, int offset)`
`int`	`serializeTo(ByteBuffer buffer)`
`int`	`serializeTo(IOBuffer buffer, int offset)`
`int`	`serializeTo(IOElasticBuffer buffer, int offset)`
`int`	`serializeTo(long addr, int offset)`
`int`	`serializeTo(PktPacket packet)`
`int`	`serializeTo(SrvMonCommandDescription.Serializer serializer)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`String`	`serializeToJson()`
`int`	`serializeToNative(long addr, int offset)` Deprecated.
`PktPacket`	`serializeToPacket()`
`String`	`serializeToRawJson()`
`void`	`setAdditionalArgs(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(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(XString val)` Copies the provided XString value into this object's 'additionalArgsDisplayName'.
`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(XString val)` Copies the provided XString value into this object's 'description'.
`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(XString val)` Copies the provided XString value into this object's 'displayName'.
`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`	`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(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`	`setReturnType(SrvMonReturnType val)` Sets the value of 'returnType'.
`void`	`sync()`
`SrvMonArgumentDescription[]`	`takeArguments()` Takes the value of 'arguments'.
`SrvMonOptionDescription[]`	`takeOptions()` Takes the value of 'options'.
`String`	`toString()`
`SrvMonCommandDescription`	`wrap(IOBuffer buffer, int len)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_ARRAY
```
public static final SrvMonCommandDescription[] EMPTY_ARRAY
```
- Method Detail
  - create
```
public static SrvMonCommandDescription create()
```
  - hasSerializedBuffer
```
public final boolean hasSerializedBuffer()
```
  - getSerializedBuffer
```
public final long getSerializedBuffer()
```
  - getSerializedBufferCapacity
```
public final int getSerializedBufferCapacity()
```
  - getSerializedBufferLength
```
public final int getSerializedBufferLength()
```
  - getSerializeToNativeLength
```
@Deprecated
public final int getSerializeToNativeLength()
```
    Deprecated.
  - serializer
```
public final SrvMonCommandDescription.Serializer serializer(int length,
                                                            boolean autoResizeTargetBuffer)
```
  - serializer
```
public final SrvMonCommandDescription.Serializer serializer(int minimumLength)
```
  - serializer
```
public final SrvMonCommandDescription.Serializer serializer()
```
  - ensureCapacity
```
public final long ensureCapacity(long addr,
                                 int capacity)
```
    Description copied from interface: AdmRuntime.BufferSizer
    
    Method invoked by the serializer to ensure there is enough space in the target buffer to accommodate a field being serialized
    
    Specified by:
    
    ensureCapacity in interface AdmRuntime.BufferSizer
    
    Parameters:
    
    addr - The native address of the target buffer
    
    capacity - The required capacity of the buffer
    
    Returns:
    
    long Returns the address of the buffer that has at least the requested capacity. This could be the same buffer that is passed in if the buffer has the capacity or a reallocated buffer if the passed in buffer did not have the requested capacity and needed to be reallocated
    This method is invoked by a serializer each time it serializes a field or part of a field to the target buffer to ensure that the target buffer has the desired capacity to hold the data being added.
  - deserializer
```
public final SrvMonCommandDescription.Deserializer deserializer(boolean createBuffer)
```
  - deserializer
```
public final SrvMonCommandDescription.Deserializer deserializer()
```
  - hasPojo
```
public final boolean hasPojo()
```
  - hasDirtyPojo
```
public final boolean hasDirtyPojo()
```
  - pojo
```
public final SrvMonCommandDescription.Pojo pojo(boolean onlyPojos)
```
  - pojo
```
public final SrvMonCommandDescription.Pojo pojo()
```
  - disposeSerializedBuffer
```
public final void disposeSerializedBuffer(boolean gcDisposed)
```
  - disposeSerializedBuffer
```
public final void disposeSerializedBuffer()
```
  - disposeSerializer
```
public final void disposeSerializer()
```
  - disposeDeserializer
```
public final void disposeDeserializer()
```
  - disposePojo
```
public final void disposePojo(boolean sync)
```
  - disposePojo
```
public final void disposePojo()
```
  - clear
```
public final void clear(boolean disposeMembers)
```
  - clear
```
public final void clear()
```
  - clearContent
```
@Deprecated
public final void clearContent()
```
    Deprecated.
  - reset
```
public final void reset(boolean disposeMembers)
```
  - reset
```
public final void reset()
```
  - serializeToRawJson
```
public final String serializeToRawJson()
```
  - serializeTo
```
public final int serializeTo(SrvMonCommandDescription.Serializer serializer)
```
  - sync
```
public final void sync()
```
  - serializeToByteArray
```
public final byte[] serializeToByteArray()
```
  - serializeTo
```
public final int serializeTo(byte[] array,
                             int offset)
```
  - serializeToByteBuffer
```
public final ByteBuffer serializeToByteBuffer()
```
  - serializeTo
```
public final int serializeTo(ByteBuffer buffer)
```
  - serializeToIOBuffer
```
public final IOBuffer serializeToIOBuffer(boolean useNative)
```
  - serializeTo
```
public final int serializeTo(IOBuffer buffer,
                             int offset)
```
  - serializeTo
```
public final int serializeTo(IOElasticBuffer buffer,
                             int offset)
```
  - serializeToPacket
```
public final PktPacket serializeToPacket()
```
  - serializeTo
```
public final int serializeTo(PktPacket packet)
```
  - serializeTo
```
public final int serializeTo(long addr,
                             int offset)
```
  - serializeToNative
```
@Deprecated
public final int serializeToNative(long addr,
                                               int offset)
```
    Deprecated.
  - serializeToJson
```
public final String serializeToJson()
```
  - deserializeFromRawJson
```
public final SrvMonCommandDescription deserializeFromRawJson(String json)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(SrvMonCommandDescription.Deserializer deserializer)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(SrvMonCommandDescription val)
```
  - wrap
```
public final SrvMonCommandDescription wrap(IOBuffer buffer,
                                           int len)
```
  - deserializeFromByteArray
```
public final SrvMonCommandDescription deserializeFromByteArray(byte[] array)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(byte[] array,
                                                      int offset,
                                                      int len)
```
  - deserializeFromByteBuffer
```
public final SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(IOBuffer buffer,
                                                      int offset,
                                                      int len)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(IOElasticBuffer buffer,
                                                      int offset,
                                                      int len)
```
  - deserializeFromPacket
```
public final SrvMonCommandDescription deserializeFromPacket(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonCommandDescription deserializeFrom(long addr,
                                                      int offset,
                                                      int len)
```
  - deserializeFromNative
```
@Deprecated
public final SrvMonCommandDescription deserializeFromNative(long addr,
                                                                        int offset,
                                                                        int len)
```
    Deprecated.
  - deserializeFromJson
```
public final SrvMonCommandDescription deserializeFromJson(String json)
```
  - copyInto
```
public final void copyInto(SrvMonCommandDescription copy)
```
  - copy
```
public final SrvMonCommandDescription copy()
```
  - needsSync
```
public boolean needsSync()
```
    Description copied from interface: MessageReflector
    
    Check if a view needs to be sync'd for reflection.
    
    Specified by:
    
    needsSync in interface MessageReflector
  - fieldExists
```
public final boolean fieldExists(Object message,
                                 String name)
```
    Description copied from interface: MessageReflector
    
    Check if a field of the supplied name exists in a message.
    
    Specified by:
    
    fieldExists in interface MessageReflector
    
    Parameters:
    
    message - The message to check in.
    
    name - The field to check for.
  - isFieldReflectable
```
public final boolean isFieldReflectable(Object message,
                                        String name)
```
    Description copied from interface: MessageReflector
    
    Check if a field of the supplied name is reflectable.
    
    Specified by:
    
    isFieldReflectable in interface MessageReflector
    
    Parameters:
    
    message - The message to check in.
    
    name - The field to check for.
    
    Returns:
    
    Returns null if a field of the supplied name is either not present in the message or is of a type that makes it non-reflectable.
  - getFieldValueAsString
```
public final String getFieldValueAsString(Object message,
                                          String name)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.
    
    Specified by:
    
    getFieldValueAsString in interface MessageReflector
    
    Parameters:
    
    message - The message to introspect.
    
    name - The field whose value is to be retrieved specified as a bean path
    
    Returns:
    
    Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsString
```
public final String getFieldValueAsString(Object message,
                                          String[] pathComponents)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    
    Specified by:
    
    getFieldValueAsString in interface MessageReflector
    
    Parameters:
    
    message - The message to introspect.
    
    pathComponents - The path components to use to access the field.
    
    Returns:
    
    Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsRawString
```
public final XString getFieldValueAsRawString(Object message,
                                              String name)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    Note that this method is generally less efficient than its variant MessageReflector.getFieldValueAsString(Object, String[]) since this method requires splitting the supplied path name into its dot separated path components. In cases where the caller intends to reuse the same path name often, it is better for the caller to supply it in split form.
    
    Specified by:
    
    getFieldValueAsRawString in interface MessageReflector
    
    Parameters:
    
    message - The message to introspect.
    
    name - The field whose value is to be retrieved specified as a bean path
    
    Returns:
    
    Returns null if a field of the supplied name is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - getFieldValueAsRawString
```
public final XString getFieldValueAsRawString(Object message,
                                              String[] pathComponents)
```
    Description copied from interface: MessageReflector
    
    Get the value of a reflectable field in a message as a string.
    
    Specified by:
    
    getFieldValueAsRawString in interface MessageReflector
    
    Parameters:
    
    message - The message to introspect.
    
    pathComponents - The path components to use to access the field.
    
    Returns:
    
    Returns null if a field of the supplied pathComponents is not in the message or the field is of a type that is not reflectable or the field value is null. The caller should differentiate between these various cases through the use of the MessageReflector.fieldExists(java.lang.Object, java.lang.String) and MessageReflector.isFieldReflectable(java.lang.Object, java.lang.String) methods
  - appendFieldValueTo
```
public final boolean appendFieldValueTo(Object message,
                                        String name,
                                        XString target)
```
    Description copied from interface: MessageReflector
    
    Appends a reflected field value as a string into the given XString.
    If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    Parameters:
    
    message - the node on which to reflect (which need not be this object).
    
    name - the bean path to the field.
    
    target - The target XString into which to append the result.
    
    Returns:
    
    true if the field was reflectable and had a value which could be appended, false otherwise.
  - appendFieldValueTo
```
public final boolean appendFieldValueTo(Object node,
                                        String[] pathComponents,
                                        XString target)
```
    Description copied from interface: MessageReflector
    
    Appends a reflected field value as a string into the given XString.
    If the field is reflectable and has a non null value, then it will be appended otherwise, this method must return false.
    
    Specified by:
    
    appendFieldValueTo in interface MessageReflector
    
    Parameters:
    
    node - the node on which to reflect (which need not be this object).
    
    pathComponents - the bean path to the field on the provided object split by its '.' separated components.
    
    target - The target XString into which to append the result.
    
    Returns:
    
    true if the field was reflectable and had a value which could be appended, false otherwise.
  - setAsReadOnly
```
public final void setAsReadOnly()
```
  - getAdditionalArgsFieldId
```
public static final int getAdditionalArgsFieldId()
```
  - setAdditionalArgs
```
public final void setAdditionalArgs(boolean val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'additionalArgs'.
    Field Description
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
    
    Specified by:
    
    setAdditionalArgs in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getAdditionalArgs
```
public final boolean getAdditionalArgs()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'additionalArgs'.
    Field Description
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
    
    Specified by:
    
    getAdditionalArgs in interface ISrvMonCommandDescription
    
    Returns:
    
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
  - getAdditionalArgsAsObject
```
public final Boolean getAdditionalArgsAsObject()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'additionalArgs'.
    Field Description
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
    
    Specified by:
    
    getAdditionalArgsAsObject in interface ISrvMonCommandDescription
    
    Returns:
    
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
  - hasAdditionalArgs
```
public final boolean hasAdditionalArgs()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'additionalArgs'.
    Field Description
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
    
    Specified by:
    
    hasAdditionalArgs in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgs()
  - clearAdditionalArgs
```
public final void clearAdditionalArgs()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'additionalArgs'.
    Field Description
    Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs).
    
    Specified by:
    
    clearAdditionalArgs in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setAdditionalArgs(boolean)
  - getReturnTypeFieldId
```
public static final int getReturnTypeFieldId()
```
  - setReturnType
```
public final void setReturnType(SrvMonReturnType val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'returnType'.
    Field Description
    The return type of this command.
    
    Specified by:
    
    setReturnType in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getReturnType
```
public final SrvMonReturnType getReturnType()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'returnType'.
    Field Description
    The return type of this command.
    
    Specified by:
    
    getReturnType in interface ISrvMonCommandDescription
    
    Returns:
    
    The return type of this command.
  - hasReturnType
```
public final boolean hasReturnType()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'returnType'.
    Field Description
    The return type of this command.
    
    Specified by:
    
    hasReturnType in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getReturnType()
  - clearReturnType
```
public final void clearReturnType()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'returnType'.
    Field Description
    The return type of this command.
    
    Specified by:
    
    clearReturnType in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setReturnType(SrvMonReturnType)
  - getHiddenFieldId
```
public static final int getHiddenFieldId()
```
  - setHidden
```
public final void setHidden(boolean val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'hidden'.
    Field Description
    Whether or not the command is hidden/internal.
    
    Specified by:
    
    setHidden in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getHidden
```
public final boolean getHidden()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'hidden'.
    Field Description
    Whether or not the command is hidden/internal.
    
    Specified by:
    
    getHidden in interface ISrvMonCommandDescription
    
    Returns:
    
    Whether or not the command is hidden/internal.
  - getHiddenAsObject
```
public final Boolean getHiddenAsObject()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'hidden'.
    Field Description
    Whether or not the command is hidden/internal.
    
    Specified by:
    
    getHiddenAsObject in interface ISrvMonCommandDescription
    
    Returns:
    
    Whether or not the command is hidden/internal.
  - hasHidden
```
public final boolean hasHidden()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'hidden'.
    Field Description
    Whether or not the command is hidden/internal.
    
    Specified by:
    
    hasHidden in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getHidden()
  - clearHidden
```
public final void clearHidden()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'hidden'.
    Field Description
    Whether or not the command is hidden/internal.
    
    Specified by:
    
    clearHidden in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setHidden(boolean)
  - getNameFieldId
```
public static final int getNameFieldId()
```
  - setName
```
public final void setName(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    setName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getName
```
public final String getName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    getName in interface ISrvMonCommandDescription
    
    Returns:
    
    The command name.
  - lendName
```
public final void lendName(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'name' to this object.
    This 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.
    Field Description
    The command name.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setNameFrom
```
public final void setNameFrom(long val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The command name.
    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.
    
    Specified by:
    
    setNameFrom in interface ISrvMonCommandDescription
  - getNameTo
```
public final <T extends XString> T getNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The command name.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getNameTo in interface ISrvMonCommandDescription
    
    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.
  - setNameFrom
```
public final void setNameFrom(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the provided XString value into this object's 'name'.
    Field Description
    The command name.
    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.
    
    Specified by:
    
    setNameFrom in interface ISrvMonCommandDescription
  - getNameTo
```
public final void getNameTo(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of 'name' into the provided XString.
    Field Description
    The command name.
    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.
    
    Specified by:
    
    getNameTo in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getName()
  - getNameUnsafe
```
public final XString getNameUnsafe()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the raw value of 'name'.
    Field Description
    The command name.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getNameUnsafe in interface ISrvMonCommandDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonCommandDescription.getName()
  - hasName
```
public final boolean hasName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    hasName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getName()
  - clearName
```
public final void clearName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    clearName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setName(String)
  - getAliasesFieldId
```
public static final int getAliasesFieldId()
```
  - setAliases
```
public final void setAliases(String[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'aliases'.
    Field Description
    The command alias.
    
    Specified by:
    
    setAliases in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setAliasesFrom
```
public final void setAliasesFrom(XIterator<String> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'aliases' using the values from the provided iterator.
    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.
    
    Field Description
    The command alias.
    NOTE:
    Passing a null or empty iterator has the same affect as calling ISrvMonCommandDescription.setAliases(String[]) with a value of null.
    
    Specified by:
    
    setAliasesFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - addAliases
```
public final void addAliases(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'aliases' values.
    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.
    
    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.
    
    Field Description
    The command alias.
    
    Specified by:
    
    addAliases in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - getAliases
```
public final String[] getAliases()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'aliases'.
    If the field is not set this method will return null.
    Field Description
    The command alias.
    
    Specified by:
    
    getAliases in interface ISrvMonCommandDescription
    
    Returns:
    
    The command alias. If the field is not set this method will return null.
  - getAliasesEmptyIfNull
```
public final String[] getAliasesEmptyIfNull()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'aliases' or an empty array if the value is null or not set.
    Field Description
    The command alias.
    
    Specified by:
    
    getAliasesEmptyIfNull in interface ISrvMonCommandDescription
    
    Returns:
    
    The command alias. or an empty array if null if not set.
    
    See Also:
    
    ISrvMonCommandDescription.getAliases()
  - getAliasesIterator
```
public final XStringIterator getAliasesIterator()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'aliases' as iterator of values.
    This 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.
    
    Field Description
    The command alias.
    
    Specified by:
    
    getAliasesIterator in interface ISrvMonCommandDescription
    
    Returns:
    
    An XStringIterator containing this field values.
  - clearAliases
```
public final void clearAliases()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'aliases'.
    Field Description
    The command alias.
    
    Specified by:
    
    clearAliases in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setAliases(String[])
  - getDescriptionFieldId
```
public static final int getDescriptionFieldId()
```
  - setDescription
```
public final void setDescription(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    setDescription in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    getDescription in interface ISrvMonCommandDescription
    
    Returns:
    
    The command description.
  - lendDescription
```
public final void lendDescription(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'description' to this object.
    This 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.
    Field Description
    The command description.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendDescription in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setDescriptionFrom
```
public final void setDescriptionFrom(long val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The command description.
    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.
    
    Specified by:
    
    setDescriptionFrom in interface ISrvMonCommandDescription
  - getDescriptionTo
```
public final <T extends XString> T getDescriptionTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The command description.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getDescriptionTo in interface ISrvMonCommandDescription
    
    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.
  - setDescriptionFrom
```
public final void setDescriptionFrom(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the provided XString value into this object's 'description'.
    Field Description
    The command description.
    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.
    
    Specified by:
    
    setDescriptionFrom in interface ISrvMonCommandDescription
  - getDescriptionTo
```
public final void getDescriptionTo(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of 'description' into the provided XString.
    Field Description
    The command description.
    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.
    
    Specified by:
    
    getDescriptionTo in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getDescription()
  - getDescriptionUnsafe
```
public final XString getDescriptionUnsafe()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the raw value of 'description'.
    Field Description
    The command description.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getDescriptionUnsafe in interface ISrvMonCommandDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonCommandDescription.getDescription()
  - hasDescription
```
public final boolean hasDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    hasDescription in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getDescription()
  - clearDescription
```
public final void clearDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    clearDescription in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setDescription(String)
  - getArgumentsFieldId
```
public static final int getArgumentsFieldId()
```
  - setArguments
```
public final void setArguments(SrvMonArgumentDescription[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'arguments'.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    setArguments in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - lendArguments
```
public final void lendArguments(SrvMonArgumentDescription[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'arguments'.
    Field Description
    The available arguments to the command.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Specified by:
    
    lendArguments in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - setArgumentsFrom
```
public final void setArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'arguments' using the values from the provided iterator.
    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.
    
    Field Description
    The available arguments to the command.
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[]) with a value of null.
    
    Specified by:
    
    setArgumentsFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - lendArgumentsFrom
```
public final void lendArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'arguments' by lending the values from the provided iterator.
    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.
    
    Field Description
    The available arguments to the command.
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[]) with a value of null.
    
    Specified by:
    
    lendArgumentsFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - addArguments
```
public final void addArguments(SrvMonArgumentDescription val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'arguments' values.
    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.
    
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    addArguments in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - lendArguments
```
public final void lendArguments(SrvMonArgumentDescription val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'arguments' values and acquires a reference to it.
    Lending 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.
    
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    lendArguments in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - getArguments
```
public final SrvMonArgumentDescription[] getArguments()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'arguments'.
    If the field is not set this method will return null.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    getArguments in interface ISrvMonCommandDescription
    
    Returns:
    
    The available arguments to the command. If the field is not set this method will return null.
  - getArgumentsEmptyIfNull
```
public final SrvMonArgumentDescription[] getArgumentsEmptyIfNull()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'arguments' or an empty array if the value is null or not set.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    getArgumentsEmptyIfNull in interface ISrvMonCommandDescription
    
    Returns:
    
    The available arguments to the command. or an empty array if null if not set.
    
    See Also:
    
    ISrvMonCommandDescription.getArguments()
  - getArgumentsCount
```
public final int getArgumentsCount()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets number of elements in 'arguments'.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    getArgumentsCount in interface ISrvMonCommandDescription
    
    Returns:
    
    The number of elements.
  - getArgumentsAt
```
public final SrvMonArgumentDescription getArgumentsAt(int index)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the element of 'arguments' at a specified index.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    getArgumentsAt in interface ISrvMonCommandDescription
    
    Parameters:
    
    index - The index for which the element is to be returned.
    
    Returns:
    
    The element.
  - getArgumentsIterator
```
public final XIterator<SrvMonArgumentDescription> getArgumentsIterator()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'arguments' as iterator of values.
    This 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 method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    getArgumentsIterator in interface ISrvMonCommandDescription
    
    Returns:
    
    An iterator containing this field values.
  - takeArguments
```
public final SrvMonArgumentDescription[] takeArguments()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Takes the value of 'arguments'.
    Field Description
    The available arguments to the command.
    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.
    
    Specified by:
    
    takeArguments in interface ISrvMonCommandDescription
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - clearArguments
```
public final void clearArguments()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'arguments'.
    Field Description
    The available arguments to the command.
    
    Specified by:
    
    clearArguments in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setArguments(SrvMonArgumentDescription[])
  - getOptionsFieldId
```
public static final int getOptionsFieldId()
```
  - setOptions
```
public final void setOptions(SrvMonOptionDescription[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'options'.
    Field Description
    The command options.
    
    Specified by:
    
    setOptions in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - lendOptions
```
public final void lendOptions(SrvMonOptionDescription[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'options'.
    Field Description
    The command options.
    NOTE:
    It is illegal to hold onto an entity 'set' on a message post the disposal of the container message. This is true even if a reference to the entity is explicitly 'acquired' by the application via acquire().
    To hold onto the reference of an entity beyond the lifecycle of its container message, an application must own a reference to the entity (via, for example, 'taking' the entity off an inbound message) and then 'lend' the entity to the message for sending. The act of 'lending' an entity to a message implies that the application continues to own the entity even though the message is holding a reference to it for the duration of the send.
    
    Specified by:
    
    lendOptions in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to 'lend' to lend.
  - setOptionsFrom
```
public final void setOptionsFrom(XIterator<SrvMonOptionDescription> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'options' using the values from the provided iterator.
    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.
    
    Field Description
    The command options.
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setOptions(SrvMonOptionDescription[]) with a value of null.
    
    Specified by:
    
    setOptionsFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - lendOptionsFrom
```
public final void lendOptionsFrom(XIterator<SrvMonOptionDescription> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'options' by lending the values from the provided iterator.
    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.
    
    Field Description
    The command options.
    NOTE:
    Passing a null or empty list has the same affect as calling ISrvMonCommandDescription.setOptions(SrvMonOptionDescription[]) with a value of null.
    
    Specified by:
    
    lendOptionsFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - addOptions
```
public final void addOptions(SrvMonOptionDescription val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'options' values.
    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.
    
    Field Description
    The command options.
    
    Specified by:
    
    addOptions in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - lendOptions
```
public final void lendOptions(SrvMonOptionDescription val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'options' values and acquires a reference to it.
    Lending 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.
    
    Field Description
    The command options.
    
    Specified by:
    
    lendOptions in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - getOptions
```
public final SrvMonOptionDescription[] getOptions()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'options'.
    If the field is not set this method will return null.
    Field Description
    The command options.
    
    Specified by:
    
    getOptions in interface ISrvMonCommandDescription
    
    Returns:
    
    The command options. If the field is not set this method will return null.
  - getOptionsEmptyIfNull
```
public final SrvMonOptionDescription[] getOptionsEmptyIfNull()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'options' or an empty array if the value is null or not set.
    Field Description
    The command options.
    
    Specified by:
    
    getOptionsEmptyIfNull in interface ISrvMonCommandDescription
    
    Returns:
    
    The command options. or an empty array if null if not set.
    
    See Also:
    
    ISrvMonCommandDescription.getOptions()
  - getOptionsCount
```
public final int getOptionsCount()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets number of elements in 'options'.
    Field Description
    The command options.
    
    Specified by:
    
    getOptionsCount in interface ISrvMonCommandDescription
    
    Returns:
    
    The number of elements.
  - getOptionsAt
```
public final SrvMonOptionDescription getOptionsAt(int index)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the element of 'options' at a specified index.
    Field Description
    The command options.
    
    Specified by:
    
    getOptionsAt in interface ISrvMonCommandDescription
    
    Parameters:
    
    index - The index for which the element is to be returned.
    
    Returns:
    
    The element.
  - getOptionsIterator
```
public final XIterator<SrvMonOptionDescription> getOptionsIterator()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'options' as iterator of values.
    This 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 method can perform a direct copy of the underlying values without iteration.
    
    Field Description
    The command options.
    
    Specified by:
    
    getOptionsIterator in interface ISrvMonCommandDescription
    
    Returns:
    
    An iterator containing this field values.
  - takeOptions
```
public final SrvMonOptionDescription[] takeOptions()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Takes the value of 'options'.
    Field Description
    The command options.
    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.
    
    Specified by:
    
    takeOptions in interface ISrvMonCommandDescription
    
    Returns:
    
    a 'taken' reference to the field or null if the field is not set.
  - clearOptions
```
public final void clearOptions()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'options'.
    Field Description
    The command options.
    
    Specified by:
    
    clearOptions in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setOptions(SrvMonOptionDescription[])
  - getDisplayNameFieldId
```
public static final int getDisplayNameFieldId()
```
  - setDisplayName
```
public final void setDisplayName(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'displayName'.
    Field Description
    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.
    
    Specified by:
    
    setDisplayName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getDisplayName
```
public final String getDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'displayName'.
    Field Description
    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.
    
    Specified by:
    
    getDisplayName in interface ISrvMonCommandDescription
    
    Returns:
    
    The display name for the command.
  - lendDisplayName
```
public final void lendDisplayName(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'displayName' to this object.
    This 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.
    Field Description
    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.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendDisplayName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setDisplayNameFrom
```
public final void setDisplayNameFrom(long val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    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.
    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.
    
    Specified by:
    
    setDisplayNameFrom in interface ISrvMonCommandDescription
  - getDisplayNameTo
```
public final <T extends XString> T getDisplayNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    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.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getDisplayNameTo in interface ISrvMonCommandDescription
    
    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.
  - setDisplayNameFrom
```
public final void setDisplayNameFrom(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the provided XString value into this object's 'displayName'.
    Field Description
    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.
    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.
    
    Specified by:
    
    setDisplayNameFrom in interface ISrvMonCommandDescription
  - getDisplayNameTo
```
public final void getDisplayNameTo(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of 'displayName' into the provided XString.
    Field Description
    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.
    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.
    
    Specified by:
    
    getDisplayNameTo in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getDisplayName()
  - getDisplayNameUnsafe
```
public final XString getDisplayNameUnsafe()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the raw value of 'displayName'.
    Field Description
    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.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getDisplayNameUnsafe in interface ISrvMonCommandDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonCommandDescription.getDisplayName()
  - hasDisplayName
```
public final boolean hasDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'displayName'.
    Field Description
    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.
    
    Specified by:
    
    hasDisplayName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getDisplayName()
  - clearDisplayName
```
public final void clearDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'displayName'.
    Field Description
    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.
    
    Specified by:
    
    clearDisplayName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setDisplayName(String)
  - getAdditionalArgsDescriptionFieldId
```
public static final int getAdditionalArgsDescriptionFieldId()
```
  - setAdditionalArgsDescription
```
public final void setAdditionalArgsDescription(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    
    Specified by:
    
    setAdditionalArgsDescription in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getAdditionalArgsDescription
```
public final String getAdditionalArgsDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    
    Specified by:
    
    getAdditionalArgsDescription in interface ISrvMonCommandDescription
    
    Returns:
    
    The description that describes how additional arguments should be specified.
  - lendAdditionalArgsDescription
```
public final void lendAdditionalArgsDescription(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'additionalArgsDescription' to this object.
    This 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.
    Field Description
    The description that describes how additional arguments should be specified.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendAdditionalArgsDescription in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setAdditionalArgsDescriptionFrom
```
public final void setAdditionalArgsDescriptionFrom(long val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The description that describes how additional arguments should be specified.
    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.
    
    Specified by:
    
    setAdditionalArgsDescriptionFrom in interface ISrvMonCommandDescription
  - getAdditionalArgsDescriptionTo
```
public final <T extends XString> T getAdditionalArgsDescriptionTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The description that describes how additional arguments should be specified.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getAdditionalArgsDescriptionTo in interface ISrvMonCommandDescription
    
    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.
  - setAdditionalArgsDescriptionFrom
```
public final void setAdditionalArgsDescriptionFrom(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the provided XString value into this object's 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    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.
    
    Specified by:
    
    setAdditionalArgsDescriptionFrom in interface ISrvMonCommandDescription
  - getAdditionalArgsDescriptionTo
```
public final void getAdditionalArgsDescriptionTo(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of 'additionalArgsDescription' into the provided XString.
    Field Description
    The description that describes how additional arguments should be specified.
    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.
    
    Specified by:
    
    getAdditionalArgsDescriptionTo in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDescription()
  - getAdditionalArgsDescriptionUnsafe
```
public final XString getAdditionalArgsDescriptionUnsafe()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the raw value of 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getAdditionalArgsDescriptionUnsafe in interface ISrvMonCommandDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDescription()
  - hasAdditionalArgsDescription
```
public final boolean hasAdditionalArgsDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    
    Specified by:
    
    hasAdditionalArgsDescription in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDescription()
  - clearAdditionalArgsDescription
```
public final void clearAdditionalArgsDescription()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'additionalArgsDescription'.
    Field Description
    The description that describes how additional arguments should be specified.
    
    Specified by:
    
    clearAdditionalArgsDescription in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setAdditionalArgsDescription(String)
  - getAdditionalArgsDisplayNameFieldId
```
public static final int getAdditionalArgsDisplayNameFieldId()
```
  - setAdditionalArgsDisplayName
```
public final void setAdditionalArgsDisplayName(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    
    Specified by:
    
    setAdditionalArgsDisplayName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - getAdditionalArgsDisplayName
```
public final String getAdditionalArgsDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    
    Specified by:
    
    getAdditionalArgsDisplayName in interface ISrvMonCommandDescription
    
    Returns:
    
    The display name to user for additional arguments.
  - lendAdditionalArgsDisplayName
```
public final void lendAdditionalArgsDisplayName(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Lends the value of 'additionalArgsDisplayName' to this object.
    This 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.
    Field Description
    The display name to user for additional arguments.
    Usage Notes
    Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.
    Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.
    
    Specified by:
    
    lendAdditionalArgsDisplayName in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setAdditionalArgsDisplayNameFrom
```
public final void setAdditionalArgsDisplayNameFrom(long val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The display name to user for additional arguments.
    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.
    
    Specified by:
    
    setAdditionalArgsDisplayNameFrom in interface ISrvMonCommandDescription
  - getAdditionalArgsDisplayNameTo
```
public final <T extends XString> T getAdditionalArgsDisplayNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The display name to user for additional arguments.
    If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);
    This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;
    
    Specified by:
    
    getAdditionalArgsDisplayNameTo in interface ISrvMonCommandDescription
    
    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.
  - setAdditionalArgsDisplayNameFrom
```
public final void setAdditionalArgsDisplayNameFrom(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the provided XString value into this object's 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    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.
    
    Specified by:
    
    setAdditionalArgsDisplayNameFrom in interface ISrvMonCommandDescription
  - getAdditionalArgsDisplayNameTo
```
public final void getAdditionalArgsDisplayNameTo(XString val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Copies the value of 'additionalArgsDisplayName' into the provided XString.
    Field Description
    The display name to user for additional arguments.
    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.
    
    Specified by:
    
    getAdditionalArgsDisplayNameTo in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDisplayName()
  - getAdditionalArgsDisplayNameUnsafe
```
public final XString getAdditionalArgsDisplayNameUnsafe()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the raw value of 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    NOTE:
    This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.
    However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.
    Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.
    
    Specified by:
    
    getAdditionalArgsDisplayNameUnsafe in interface ISrvMonCommandDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDisplayName()
  - hasAdditionalArgsDisplayName
```
public final boolean hasAdditionalArgsDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Checks for the presence of 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    
    Specified by:
    
    hasAdditionalArgsDisplayName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.getAdditionalArgsDisplayName()
  - clearAdditionalArgsDisplayName
```
public final void clearAdditionalArgsDisplayName()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'additionalArgsDisplayName'.
    Field Description
    The display name to user for additional arguments.
    
    Specified by:
    
    clearAdditionalArgsDisplayName in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setAdditionalArgsDisplayName(String)
  - getGroupFieldId
```
public static final int getGroupFieldId()
```
  - setGroup
```
public final void setGroup(String[] val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'group'.
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    setGroup in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - The value to set.
  - setGroupFrom
```
public final void setGroupFrom(XIterator<String> val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Sets the value of 'group' using the values from the provided iterator.
    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.
    
    Field Description
    The group hierarchy this command belongs to.
    NOTE:
    Passing a null or empty iterator has the same affect as calling ISrvMonCommandDescription.setGroup(String[]) with a value of null.
    
    Specified by:
    
    setGroupFrom in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the values to set.
  - addGroup
```
public final void addGroup(String val)
```
    Description copied from interface: ISrvMonCommandDescription
    
    Adds the provided value to the list of 'group' values.
    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.
    
    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.
    
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    addGroup in interface ISrvMonCommandDescription
    
    Parameters:
    
    val - the value to add.
  - getGroup
```
public final String[] getGroup()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'group'.
    If the field is not set this method will return null.
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    getGroup in interface ISrvMonCommandDescription
    
    Returns:
    
    The group hierarchy this command belongs to. If the field is not set this method will return null.
  - getGroupEmptyIfNull
```
public final String[] getGroupEmptyIfNull()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'group' or an empty array if the value is null or not set.
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    getGroupEmptyIfNull in interface ISrvMonCommandDescription
    
    Returns:
    
    The group hierarchy this command belongs to. or an empty array if null if not set.
    
    See Also:
    
    ISrvMonCommandDescription.getGroup()
  - getGroupIterator
```
public final XStringIterator getGroupIterator()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Gets the value of 'group' as iterator of values.
    This 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.
    
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    getGroupIterator in interface ISrvMonCommandDescription
    
    Returns:
    
    An XStringIterator containing this field values.
  - clearGroup
```
public final void clearGroup()
```
    Description copied from interface: ISrvMonCommandDescription
    
    Clears the value of 'group'.
    Field Description
    The group hierarchy this command belongs to.
    
    Specified by:
    
    clearGroup in interface ISrvMonCommandDescription
    
    See Also:
    
    ISrvMonCommandDescription.setGroup(String[])
  - getFieldReflector
```
public static final <T> IRogFieldReflector<SrvMonCommandDescription,T> getFieldReflector(String name)
```
    Get a field reflector.
    
    Parameters:
    
    name - The name of the field ('.' delimited for nested fields)
    
    Returns:
    
    The reflectable field reflector for the field of the supplied name or null if no reflectable field of the supplied name exists
  - getFieldReflector
```
public static final <T> IRogFieldReflector<SrvMonCommandDescription,T> getFieldReflector(String[] pathComponents)
```
    Get a field reflector.
    
    Parameters:
    
    pathComponents - The path to the field whose reflector is to be returned
    
    Returns:
    
    The reflectable field reflector for the field of the supplied path or null if no reflectable field of the supplied name exists
  - getQueryFieldValue
```
public final Object getQueryFieldValue(String name)
```
    Description copied from interface: com.neeve.query.impl.index.IdxMappable
    
    Gets an indexable value identified by a key.
    Implementation should ensure that the the type of the value returned is consistent across types.
    
    Specified by:
    
    getQueryFieldValue in interface com.neeve.query.impl.index.IdxMappable
    
    Parameters:
    
    name - The name of the field whose value is to be accessed.
    
    Returns:
    
    The value.
  - init
```
public final SrvMonCommandDescription init()
```
    Description copied from interface: UtlPool.Item
    
    Initialize an item.
    This method is invoked by an item pool very time an item is put into the pool. The method should wipe the contents of the item so as to present a fresh instance of the item to the caller when retrieved from the pool.
    
    Specified by:
    
    init in interface UtlPool.Item<SrvMonCommandDescription>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonCommandDescription setPool(UtlPool<SrvMonCommandDescription> pool)
```
    Description copied from interface: UtlPool.Item
    
    Set a pool item's pool.
    This method is invoked by an item pool at the time an item is added to the pool. The intent is to record the item's source pool in the item so it can be disposed back into the pool when the user is done working with it.
    
    Specified by:
    
    setPool in interface UtlPool.Item<SrvMonCommandDescription>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonCommandDescription> getPool()
```
    Description copied from interface: UtlPool.Item
    
    Get a pool item's pool.
    This method should return the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
    
    Specified by:
    
    getPool in interface UtlPool.Item<SrvMonCommandDescription>
    
    Returns:
    
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - acquire
```
public final SrvMonCommandDescription acquire()
```
  - getOwnershipCount
```
public final int getOwnershipCount()
```
  - dispose
```
public final void dispose()
```
  - clone
```
public final Object clone()
```
    Creates a clone of this object.
    This method differs from the copy() method in that:
    - For protobuf and xbuf generated objects pass-through fields are not preserved. Pass through fields are fields not defined by ADM model that generated this class, but may exist in the backing buffer or protobuf message for the object.
    - The copy method may replace empty arrays with a null value whereas this method preserves empty array fields.
    Overrides:
    
    clone in class Object
  - isValid
```
public final boolean isValid()
```
    Description copied from interface: IRogValidatable
    
    Tests if this object has any validation errors.
    
    Specified by:
    
    isValid in interface IRogValidatable
  - getValidationErrors
```
public final void getValidationErrors(List<XString> results,
                                      String errorPrefix)
```
    Description copied from interface: IRogValidatable
    
    Collects validation errors into the provided list. It is illegal for the caller to hold onto the List of XStrings beyond the lifespace of this object.
    
    Specified by:
    
    getValidationErrors in interface IRogValidatable
    
    Parameters:
    
    results - A results list into which validation errors will be collected.
    
    errorPrefix - The bean path prefix to use when identifying invalid fields or null if validating a top level entity.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object

Class SrvMonCommandDescription

ADM Details

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_ARRAY

Method Detail

create

hasSerializedBuffer

getSerializedBuffer

getSerializedBufferCapacity

getSerializedBufferLength

getSerializeToNativeLength

serializer

serializer

serializer

ensureCapacity

deserializer

deserializer

hasPojo

hasDirtyPojo

pojo

pojo

disposeSerializedBuffer

disposeSerializedBuffer

disposeSerializer

disposeDeserializer

disposePojo

disposePojo

clear

clear

clearContent

reset

reset

serializeToRawJson

serializeTo

sync

serializeToByteArray

serializeTo

serializeToByteBuffer

serializeTo

serializeToIOBuffer

serializeTo

serializeTo

serializeToPacket

serializeTo

serializeTo

serializeToNative

serializeToJson

deserializeFromRawJson

deserializeFrom

deserializeFrom

wrap

deserializeFromByteArray

deserializeFrom

deserializeFromByteBuffer

deserializeFrom

deserializeFrom

deserializeFrom

deserializeFromPacket

deserializeFrom

deserializeFrom

deserializeFromNative

deserializeFromJson

copyInto

copy

needsSync

fieldExists

isFieldReflectable

getFieldValueAsString

getFieldValueAsString

getFieldValueAsRawString

getFieldValueAsRawString

appendFieldValueTo

appendFieldValueTo

setAsReadOnly

getAdditionalArgsFieldId

setAdditionalArgs