SrvMonArgumentDescription (Rumi 4.0.595 API)

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

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

@Generated(value="com.neeve.protobuf.adm.ProtobufAdmNodeGenerator",
           date="Tue Sep 16 04:36:05 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=301)
public final class SrvMonArgumentDescription
extends Object
implements ISrvMonArgumentDescription, MessageReflector, com.neeve.query.impl.index.IdxMappable, UtlPool.Item<SrvMonArgumentDescription>, AdmRuntime.BufferSizer

Describes a command argument.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
defaultValue	String	19	The default value for the argument when not specified ... or not set if no default.
description	String	22	The command description.
displayName	String	23	The display name for the argument. 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.
name	String	16	The command name.
position	Short	17	The position at which the argument must be specified.
required	Boolean	18	Whether or not the argument is required.
type	`SrvMonArgumentType`	20	Describes the type of the argument.
validValues	String[]	21	When set restricts the set of valid values for the command.

Nested Class Summary

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

Field Summary

Fields
Modifier and Type Field and Description

static SrvMonArgumentDescription[] EMPTY_ARRAY

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`SrvMonArgumentDescription`	`acquire()`
`void`	`addValidValues(String val)` Adds the provided value to the list of 'validValues' 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`	`clearContent()` Deprecated.
`void`	`clearDefaultValue()` Clears the value of 'defaultValue'.
`void`	`clearDescription()` Clears the value of 'description'.
`void`	`clearDisplayName()` Clears the value of 'displayName'.
`void`	`clearName()` Clears the value of 'name'.
`void`	`clearPosition()` Clears the value of 'position'.
`void`	`clearRequired()` Clears the value of 'required'.
`void`	`clearType()` Clears the value of 'type'.
`void`	`clearValidValues()` Clears the value of 'validValues'.
`Object`	`clone()` Creates a clone of this object.
`SrvMonArgumentDescription`	`copy()`
`void`	`copyInto(SrvMonArgumentDescription copy)`
`static SrvMonArgumentDescription`	`create()`
`SrvMonArgumentDescription`	`deserializeFrom(byte[] array, int offset, int len)`
`SrvMonArgumentDescription`	`deserializeFrom(ByteBuffer buffer)`
`SrvMonArgumentDescription`	`deserializeFrom(IOBuffer buffer, int offset, int len)`
`SrvMonArgumentDescription`	`deserializeFrom(IOElasticBuffer buffer, int offset, int len)`
`SrvMonArgumentDescription`	`deserializeFrom(long addr, int offset, int len)`
`SrvMonArgumentDescription`	`deserializeFrom(PktPacket packet)`
`SrvMonArgumentDescription`	`deserializeFrom(SrvMonArgumentDescription.Deserializer deserializer)`
`SrvMonArgumentDescription`	`deserializeFrom(SrvMonArgumentDescription val)`
`SrvMonArgumentDescription`	`deserializeFromByteArray(byte[] array)`
`SrvMonArgumentDescription`	`deserializeFromByteBuffer(ByteBuffer buffer)`
`SrvMonArgumentDescription`	`deserializeFromJson(String json)`
`SrvMonArgumentDescription`	`deserializeFromNative(long addr, int offset, int len)` Deprecated.
`SrvMonArgumentDescription`	`deserializeFromPacket(PktPacket packet)`
`SrvMonArgumentDescription`	`deserializeFromRawJson(String json)`
`SrvMonArgumentDescription.Deserializer`	`deserializer()`
`SrvMonArgumentDescription.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.
`String`	`getDefaultValue()` Gets the value of 'defaultValue'.
`static int`	`getDefaultValueFieldId()`
`<T extends XString> T`	`getDefaultValueTo(IXStringFactory<T> factory)` Copies the value of this String field into a new XString from the given factory.
`void`	`getDefaultValueTo(XString val)` Copies the value of 'defaultValue' into the provided XString.
`XString`	`getDefaultValueUnsafe()` Gets the raw value of 'defaultValue'.
`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<SrvMonArgumentDescription,T>`	`getFieldReflector(String name)` Get a field reflector.
`static <T> IRogFieldReflector<SrvMonArgumentDescription,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`	`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'.
`int`	`getOwnershipCount()`
`UtlPool<SrvMonArgumentDescription>`	`getPool()` Get a pool item's pool.
`short`	`getPosition()` Gets the value of 'position'.
`Short`	`getPositionAsObject()` Gets the value of 'position'.
`static int`	`getPositionFieldId()`
`Object`	`getQueryFieldValue(String name)` Gets an indexable value identified by a key.
`boolean`	`getRequired()` Gets the value of 'required'.
`Boolean`	`getRequiredAsObject()` Gets the value of 'required'.
`static int`	`getRequiredFieldId()`
`long`	`getSerializedBuffer()`
`int`	`getSerializedBufferCapacity()`
`int`	`getSerializedBufferLength()`
`int`	`getSerializeToNativeLength()` Deprecated.
`SrvMonArgumentType`	`getType()` Gets the value of 'type'.
`static int`	`getTypeFieldId()`
`void`	`getValidationErrors(List<XString> results, String errorPrefix)` Collects validation errors into the provided list.
`String[]`	`getValidValues()` Gets the value of 'validValues'.
`String[]`	`getValidValuesEmptyIfNull()` Gets the value of 'validValues' or an empty array if the value is `null` or not set.
`static int`	`getValidValuesFieldId()`
`XStringIterator`	`getValidValuesIterator()` Gets the value of 'validValues' as iterator of values.
`boolean`	`hasDefaultValue()` Checks for the presence of 'defaultValue'.
`boolean`	`hasDescription()` Checks for the presence of 'description'.
`boolean`	`hasDirtyPojo()`
`boolean`	`hasDisplayName()` Checks for the presence of 'displayName'.
`boolean`	`hasName()` Checks for the presence of 'name'.
`boolean`	`hasPojo()`
`boolean`	`hasPosition()` Checks for the presence of 'position'.
`boolean`	`hasRequired()` Checks for the presence of 'required'.
`boolean`	`hasSerializedBuffer()`
`boolean`	`hasType()` Checks for the presence of 'type'.
`SrvMonArgumentDescription`	`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`	`lendDefaultValue(XString val)` Lends the value of 'defaultValue' to this object.
`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.
`boolean`	`needsSync()` Check if a view needs to be sync'd for reflection.
`SrvMonArgumentDescription.Pojo`	`pojo()`
`SrvMonArgumentDescription.Pojo`	`pojo(boolean onlyPojos)`
`void`	`reset()`
`void`	`reset(boolean disposeMembers)`
`SrvMonArgumentDescription.Serializer`	`serializer()`
`SrvMonArgumentDescription.Serializer`	`serializer(int minimumLength)`
`SrvMonArgumentDescription.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(SrvMonArgumentDescription.Serializer serializer)`
`byte[]`	`serializeToByteArray()`
`ByteBuffer`	`serializeToByteBuffer()`
`IOBuffer`	`serializeToIOBuffer(boolean useNative)`
`String`	`serializeToJson()`
`int`	`serializeToNative(long addr, int offset)` Deprecated.
`PktPacket`	`serializeToPacket()`
`String`	`serializeToRawJson()`
`void`	`setAsReadOnly()`
`void`	`setDefaultValue(String val)` Sets the value of 'defaultValue'.
`void`	`setDefaultValueFrom(long val)` Sets the value of this String field to the given numeric value.
`void`	`setDefaultValueFrom(XString val)` Copies the provided XString value into this object's 'defaultValue'.
`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`	`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'.
`SrvMonArgumentDescription`	`setPool(UtlPool<SrvMonArgumentDescription> pool)` Set a pool item's pool.
`void`	`setPosition(short val)` Sets the value of 'position'.
`void`	`setRequired(boolean val)` Sets the value of 'required'.
`void`	`setType(SrvMonArgumentType val)` Sets the value of 'type'.
`void`	`setValidValues(String[] val)` Sets the value of 'validValues'.
`void`	`setValidValuesFrom(XIterator<String> val)` Sets the value of 'validValues' using the values from the provided iterator.
`void`	`sync()`
`String`	`toString()`
`SrvMonArgumentDescription`	`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 SrvMonArgumentDescription[] EMPTY_ARRAY
```
- Method Detail
  - create
```
public static SrvMonArgumentDescription 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 SrvMonArgumentDescription.Serializer serializer(int length,
                                                             boolean autoResizeTargetBuffer)
```
  - serializer
```
public final SrvMonArgumentDescription.Serializer serializer(int minimumLength)
```
  - serializer
```
public final SrvMonArgumentDescription.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 SrvMonArgumentDescription.Deserializer deserializer(boolean createBuffer)
```
  - deserializer
```
public final SrvMonArgumentDescription.Deserializer deserializer()
```
  - hasPojo
```
public final boolean hasPojo()
```
  - hasDirtyPojo
```
public final boolean hasDirtyPojo()
```
  - pojo
```
public final SrvMonArgumentDescription.Pojo pojo(boolean onlyPojos)
```
  - pojo
```
public final SrvMonArgumentDescription.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(SrvMonArgumentDescription.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 SrvMonArgumentDescription deserializeFromRawJson(String json)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(SrvMonArgumentDescription.Deserializer deserializer)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(SrvMonArgumentDescription val)
```
  - wrap
```
public final SrvMonArgumentDescription wrap(IOBuffer buffer,
                                            int len)
```
  - deserializeFromByteArray
```
public final SrvMonArgumentDescription deserializeFromByteArray(byte[] array)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(byte[] array,
                                                       int offset,
                                                       int len)
```
  - deserializeFromByteBuffer
```
public final SrvMonArgumentDescription deserializeFromByteBuffer(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(ByteBuffer buffer)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(IOBuffer buffer,
                                                       int offset,
                                                       int len)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(IOElasticBuffer buffer,
                                                       int offset,
                                                       int len)
```
  - deserializeFromPacket
```
public final SrvMonArgumentDescription deserializeFromPacket(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(PktPacket packet)
```
  - deserializeFrom
```
public final SrvMonArgumentDescription deserializeFrom(long addr,
                                                       int offset,
                                                       int len)
```
  - deserializeFromNative
```
@Deprecated
public final SrvMonArgumentDescription deserializeFromNative(long addr,
                                                                         int offset,
                                                                         int len)
```
    Deprecated.
  - deserializeFromJson
```
public final SrvMonArgumentDescription deserializeFromJson(String json)
```
  - copyInto
```
public final void copyInto(SrvMonArgumentDescription copy)
```
  - copy
```
public final SrvMonArgumentDescription 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()
```
  - getPositionFieldId
```
public static final int getPositionFieldId()
```
  - setPosition
```
public final void setPosition(short val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'position'.
    Field Description
    The position at which the argument must be specified.
    
    Specified by:
    
    setPosition in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getPosition
```
public final short getPosition()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'position'.
    Field Description
    The position at which the argument must be specified.
    
    Specified by:
    
    getPosition in interface ISrvMonArgumentDescription
    
    Returns:
    
    The position at which the argument must be specified.
  - getPositionAsObject
```
public final Short getPositionAsObject()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'position'.
    Field Description
    The position at which the argument must be specified.
    
    Specified by:
    
    getPositionAsObject in interface ISrvMonArgumentDescription
    
    Returns:
    
    The position at which the argument must be specified.
  - hasPosition
```
public final boolean hasPosition()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'position'.
    Field Description
    The position at which the argument must be specified.
    
    Specified by:
    
    hasPosition in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getPosition()
  - clearPosition
```
public final void clearPosition()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'position'.
    Field Description
    The position at which the argument must be specified.
    
    Specified by:
    
    clearPosition in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setPosition(short)
  - getRequiredFieldId
```
public static final int getRequiredFieldId()
```
  - setRequired
```
public final void setRequired(boolean val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'required'.
    Field Description
    Whether or not the argument is required.
    
    Specified by:
    
    setRequired in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getRequired
```
public final boolean getRequired()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'required'.
    Field Description
    Whether or not the argument is required.
    
    Specified by:
    
    getRequired in interface ISrvMonArgumentDescription
    
    Returns:
    
    Whether or not the argument is required.
  - getRequiredAsObject
```
public final Boolean getRequiredAsObject()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'required'.
    Field Description
    Whether or not the argument is required.
    
    Specified by:
    
    getRequiredAsObject in interface ISrvMonArgumentDescription
    
    Returns:
    
    Whether or not the argument is required.
  - hasRequired
```
public final boolean hasRequired()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'required'.
    Field Description
    Whether or not the argument is required.
    
    Specified by:
    
    hasRequired in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getRequired()
  - clearRequired
```
public final void clearRequired()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'required'.
    Field Description
    Whether or not the argument is required.
    
    Specified by:
    
    clearRequired in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setRequired(boolean)
  - getTypeFieldId
```
public static final int getTypeFieldId()
```
  - setType
```
public final void setType(SrvMonArgumentType val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'type'.
    Field Description
    Describes the type of the argument.
    
    Specified by:
    
    setType in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getType
```
public final SrvMonArgumentType getType()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'type'.
    Field Description
    Describes the type of the argument.
    
    Specified by:
    
    getType in interface ISrvMonArgumentDescription
    
    Returns:
    
    Describes the type of the argument.
  - hasType
```
public final boolean hasType()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'type'.
    Field Description
    Describes the type of the argument.
    
    Specified by:
    
    hasType in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getType()
  - clearType
```
public final void clearType()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'type'.
    Field Description
    Describes the type of the argument.
    
    Specified by:
    
    clearType in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setType(SrvMonArgumentType)
  - getNameFieldId
```
public static final int getNameFieldId()
```
  - setName
```
public final void setName(String val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    setName in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getName
```
public final String getName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    getName in interface ISrvMonArgumentDescription
    
    Returns:
    
    The command name.
  - lendName
```
public final void lendName(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - setNameFrom
```
public final void setNameFrom(long val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The command name.
    NOTE:
    This is the same as calling ISrvMonArgumentDescription.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 ISrvMonArgumentDescription
  - getNameTo
```
public final <T extends XString> T getNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    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: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription.setName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setNameFrom in interface ISrvMonArgumentDescription
  - getNameTo
```
public final void getNameTo(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription.getName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getNameTo in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getName()
  - getNameUnsafe
```
public final XString getNameUnsafe()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonArgumentDescription.getName()
  - hasName
```
public final boolean hasName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    hasName in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getName()
  - clearName
```
public final void clearName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'name'.
    Field Description
    The command name.
    
    Specified by:
    
    clearName in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setName(String)
  - getDefaultValueFieldId
```
public static final int getDefaultValueFieldId()
```
  - setDefaultValue
```
public final void setDefaultValue(String val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    
    Specified by:
    
    setDefaultValue in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getDefaultValue
```
public final String getDefaultValue()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    
    Specified by:
    
    getDefaultValue in interface ISrvMonArgumentDescription
    
    Returns:
    
    The default value for the argument when not specified ... or not set if no default.
  - lendDefaultValue
```
public final void lendDefaultValue(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Lends the value of 'defaultValue' to this object.
    This method is equivalent to setDefaultValue 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 default value for the argument when not specified ... or not set if no default.
    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:
    
    lendDefaultValue in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - setDefaultValueFrom
```
public final void setDefaultValueFrom(long val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    NOTE:
    This is the same as calling ISrvMonArgumentDescription.setDefaultValue(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.
    
    Specified by:
    
    setDefaultValueFrom in interface ISrvMonArgumentDescription
  - getDefaultValueTo
```
public final <T extends XString> T getDefaultValueTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    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:
    
    getDefaultValueTo in interface ISrvMonArgumentDescription
    
    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.
  - setDefaultValueFrom
```
public final void setDefaultValueFrom(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Copies the provided XString value into this object's 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than ISrvMonArgumentDescription.setDefaultValue(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setDefaultValueFrom in interface ISrvMonArgumentDescription
  - getDefaultValueTo
```
public final void getDefaultValueTo(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Copies the value of 'defaultValue' into the provided XString.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    NOTE:
    This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than ISrvMonArgumentDescription.getDefaultValue() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getDefaultValueTo in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDefaultValue()
  - getDefaultValueUnsafe
```
public final XString getDefaultValueUnsafe()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the raw value of 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    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:
    
    getDefaultValueUnsafe in interface ISrvMonArgumentDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonArgumentDescription.getDefaultValue()
  - hasDefaultValue
```
public final boolean hasDefaultValue()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    
    Specified by:
    
    hasDefaultValue in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDefaultValue()
  - clearDefaultValue
```
public final void clearDefaultValue()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'defaultValue'.
    Field Description
    The default value for the argument when not specified ... or not set if no default.
    
    Specified by:
    
    clearDefaultValue in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setDefaultValue(String)
  - getValidValuesFieldId
```
public static final int getValidValuesFieldId()
```
  - setValidValues
```
public final void setValidValues(String[] val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'validValues'.
    Field Description
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    setValidValues in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - setValidValuesFrom
```
public final void setValidValuesFrom(XIterator<String> val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'validValues' 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 'validValues' accessor can copy the values without iteration.
    
    Field Description
    When set restricts the set of valid values for the command.
    NOTE:
    Passing a null or empty iterator has the same affect as calling ISrvMonArgumentDescription.setValidValues(String[]) with a value of null.
    
    Specified by:
    
    setValidValuesFrom in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - the values to set.
  - addValidValues
```
public final void addValidValues(String val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Adds the provided value to the list of 'validValues' values.
    This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'validValues' 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
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    addValidValues in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - the value to add.
  - getValidValues
```
public final String[] getValidValues()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'validValues'.
    If the field is not set this method will return null.
    Field Description
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    getValidValues in interface ISrvMonArgumentDescription
    
    Returns:
    
    When set restricts the set of valid values for the command. If the field is not set this method will return null.
  - getValidValuesEmptyIfNull
```
public final String[] getValidValuesEmptyIfNull()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'validValues' or an empty array if the value is null or not set.
    Field Description
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    getValidValuesEmptyIfNull in interface ISrvMonArgumentDescription
    
    Returns:
    
    When set restricts the set of valid values for the command. or an empty array if null if not set.
    
    See Also:
    
    ISrvMonArgumentDescription.getValidValues()
  - getValidValuesIterator
```
public final XStringIterator getValidValuesIterator()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'validValues' 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
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    getValidValuesIterator in interface ISrvMonArgumentDescription
    
    Returns:
    
    An XStringIterator containing this field values.
  - clearValidValues
```
public final void clearValidValues()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'validValues'.
    Field Description
    When set restricts the set of valid values for the command.
    
    Specified by:
    
    clearValidValues in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setValidValues(String[])
  - getDescriptionFieldId
```
public static final int getDescriptionFieldId()
```
  - setDescription
```
public final void setDescription(String val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    setDescription in interface ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    getDescription in interface ISrvMonArgumentDescription
    
    Returns:
    
    The command description.
  - lendDescription
```
public final void lendDescription(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - setDescriptionFrom
```
public final void setDescriptionFrom(long val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The command description.
    NOTE:
    This is the same as calling ISrvMonArgumentDescription.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 ISrvMonArgumentDescription
  - getDescriptionTo
```
public final <T extends XString> T getDescriptionTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    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: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription.setDescription(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setDescriptionFrom in interface ISrvMonArgumentDescription
  - getDescriptionTo
```
public final void getDescriptionTo(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription.getDescription() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getDescriptionTo in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDescription()
  - getDescriptionUnsafe
```
public final XString getDescriptionUnsafe()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 ISrvMonArgumentDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonArgumentDescription.getDescription()
  - hasDescription
```
public final boolean hasDescription()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    hasDescription in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDescription()
  - clearDescription
```
public final void clearDescription()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'description'.
    Field Description
    The command description.
    
    Specified by:
    
    clearDescription in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setDescription(String)
  - getDisplayNameFieldId
```
public static final int getDisplayNameFieldId()
```
  - setDisplayName
```
public final void setDisplayName(String val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - getDisplayName
```
public final String getDisplayName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the value of 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    Returns:
    
    The display name for the argument.
  - lendDisplayName
```
public final void lendDisplayName(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    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 argument.
    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 ISrvMonArgumentDescription
    
    Parameters:
    
    val - The value to set.
  - setDisplayNameFrom
```
public final void setDisplayNameFrom(long val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Sets the value of this String field to the given numeric value.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription.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 ISrvMonArgumentDescription
  - getDisplayNameTo
```
public final <T extends XString> T getDisplayNameTo(IXStringFactory<T> factory)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Copies the value of this String field into a new XString from the given factory.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    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: ISrvMonArgumentDescription
    
    Copies the provided XString value into this object's 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription.setDisplayName(String) because it avoids encoding the value into a String if the given XString is already encoded.
    
    Specified by:
    
    setDisplayNameFrom in interface ISrvMonArgumentDescription
  - getDisplayNameTo
```
public final void getDisplayNameTo(XString val)
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Copies the value of 'displayName' into the provided XString.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription.getDisplayName() bec because it can avoid decoding the value into an String.
    
    Specified by:
    
    getDisplayNameTo in interface ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDisplayName()
  - getDisplayNameUnsafe
```
public final XString getDisplayNameUnsafe()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Gets the raw value of 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    Returns:
    
    the field's raw value
    
    See Also:
    
    ISrvMonArgumentDescription.getDisplayName()
  - hasDisplayName
```
public final boolean hasDisplayName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Checks for the presence of 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.getDisplayName()
  - clearDisplayName
```
public final void clearDisplayName()
```
    Description copied from interface: ISrvMonArgumentDescription
    
    Clears the value of 'displayName'.
    Field Description
    The display name for the argument.
    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 ISrvMonArgumentDescription
    
    See Also:
    
    ISrvMonArgumentDescription.setDisplayName(String)
  - getFieldReflector
```
public static final <T> IRogFieldReflector<SrvMonArgumentDescription,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<SrvMonArgumentDescription,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 SrvMonArgumentDescription 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<SrvMonArgumentDescription>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - setPool
```
public final SrvMonArgumentDescription setPool(UtlPool<SrvMonArgumentDescription> 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<SrvMonArgumentDescription>
    
    Returns:
    
    Return 'this' object for method invocation chaining.
  - getPool
```
public final UtlPool<SrvMonArgumentDescription> 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<SrvMonArgumentDescription>
    
    Returns:
    
    the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool<T>)
  - acquire
```
public final SrvMonArgumentDescription 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 SrvMonArgumentDescription

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

getPositionFieldId

setPosition