Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.neeve.server.mon.cnc
Class SrvMonCommandDescription

java.lang.Object
  extended by com.neeve.server.mon.cnc.SrvMonCommandDescription
All Implemented Interfaces:
IRogValidatable, ISrvMonCommandDescription, UtlPool.Item<SrvMonCommandDescription>, com.neeve.xbuf.IXbufDesyncer
@Generated(value="com.neeve.adm.AdmXbufGenerator",
           date="Wed Jun 06 14:04:25 EDT 2018")
@AdmGenerated(encoding="Xbuf",
              compatLevel="3.8.0",
              admVersion="nvx-adm v3.7.275 (build 0)",
              date="6/6/18 2:04 PM",
              buildInfo="nvx-talon-3.7.275 (nvx-codegen-plugin)")
@AdmFactoryInfo(factoryClass=SrvMonCncFactory.class,
                vfid=36,
                ofid=36,
                typeId=300)
public final class SrvMonCommandDescription
extends Object
implements com.neeve.xbuf.IXbufDesyncer, UtlPool.Item<SrvMonCommandDescription>, ISrvMonCommandDescription

Describes a command

Nested Class Summary
static class SrvMonCommandDescription.Field
          The SrvMonCommandDescription xbuf field (used internally when this entity is used as a field of another entity).
static class SrvMonCommandDescription.ListField
          The SrvMonCommandDescription list field (used internally when this entity is used as an array field of another entity).
 
Field Summary
static SrvMonCommandDescription[] EMPTY_ARRAY
          A preallocated empty array used to avoid garbage when returning empty arrays of this type.
 
Constructor Summary
SrvMonCommandDescription()
           
SrvMonCommandDescription(int initialBackingBufferSize)
           
 
Method Summary
 SrvMonCommandDescription acquire()
           
 void addAliases(String val)
          Adds the provided value to the list of 'aliases' values.
 void addArguments(SrvMonArgumentDescription val)
          Adds the provided value to the list of 'arguments' values.
 void addGroup(String val)
          Adds the provided value to the list of 'group' values.
 void addOptions(SrvMonOptionDescription val)
          Adds the provided value to the list of 'options' values.
 void clearAdditionalArgs()
          Clears the value of 'additionalArgs' Field Description Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs)
 void clearAdditionalArgsDescription()
          Clears the value of 'additionalArgsDescription' Field Description The description that describes how additional arguments should be specified.
 void clearAdditionalArgsDisplayName()
          Clears the value of 'additionalArgsDisplayName' Field Description The display name to user for additional arguments.
 void clearAliases()
          Clears the value of 'aliases' Field Description The command alias
 void clearArguments()
          Clears the value of 'arguments' Field Description The available arguments to the command
 void clearContent()
           
 void clearDescription()
          Clears the value of 'description' Field Description The command description
 void clearDisplayName()
          Clears the value of 'displayName' Field Description The display name for the command.
 void clearGroup()
          Clears the value of 'group' Field Description The group hierarchy this command belongs to.
 void clearHidden()
          Clears the value of 'hidden' Field Description Whether or not the command is hidden/internal
 void clearName()
          Clears the value of 'name' Field Description The command name
 void clearOptions()
          Clears the value of 'options' Field Description The command options
 void clearReturnType()
          Clears the value of 'returnType' Field Description The return type of this command
 void clearXRogType()
           
 Object clone()
          Creates a clone of this object.
 SrvMonCommandDescription copy()
          Creates a copy of this SrvMonCommandDescription.
 void copyInto(SrvMonCommandDescription copy)
          Copies the contents of this SrvMonCommandDescription into the target.
static SrvMonCommandDescription create()
           
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer createAliasesFieldBuffer(int initialBufferLength, boolean isNative)
          Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.
static SrvMonCommandDescription createFrom(byte[] serializedContainer)
           
static SrvMonCommandDescription createFrom(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer)
           
static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
static com.neeve.xbuf.XbufRepeatedStringFieldBuffer createGroupFieldBuffer(int initialBufferLength, boolean isNative)
          Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.
static com.neeve.xbuf.XbufSchema createSchema()
           
 SrvMonCommandDescription deserializeFromByteArray(byte[] array)
           
 SrvMonCommandDescription deserializeFromByteArray(byte[] array, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer)
           
 SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length)
           
 SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 SrvMonCommandDescription deserializeFromNative(long address, int offset, int length)
           
 SrvMonCommandDescription deserializeFromNative(long address, int offset, int length, com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)
           
 int desync(PktBuffer buffer, int pos, boolean frameOnly)
           
 void desyncFieldBitmask()
           
 void dispose()
           
 boolean getAdditionalArgs()
          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)
 String getAdditionalArgsDescription()
          Gets the value of 'additionalArgsDescription' Field Description The description that describes how additional arguments should be specified.
 com.neeve.xbuf.XbufStringField getAdditionalArgsDescriptionField()
           
static int getAdditionalArgsDescriptionFieldId()
          Get the field id for 'additionalArgsDescription' This method can be used to set field interests.
<T extends XString>
T
getAdditionalArgsDescriptionTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getAdditionalArgsDescriptionTo(XString val)
          Copies the value of 'additionalArgsDescription' into the provided XString.
 XString getAdditionalArgsDescriptionUnsafe()
          Gets the raw value of 'additionalArgsDescription'.
 String getAdditionalArgsDisplayName()
          Gets the value of 'additionalArgsDisplayName' Field Description The display name to user for additional arguments.
 com.neeve.xbuf.XbufStringField getAdditionalArgsDisplayNameField()
           
static int getAdditionalArgsDisplayNameFieldId()
          Get the field id for 'additionalArgsDisplayName' This method can be used to set field interests.
<T extends XString>
T
getAdditionalArgsDisplayNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getAdditionalArgsDisplayNameTo(XString val)
          Copies the value of 'additionalArgsDisplayName' into the provided XString.
 XString getAdditionalArgsDisplayNameUnsafe()
          Gets the raw value of 'additionalArgsDisplayName'.
 com.neeve.xbuf.XbufVariableBooleanField getAdditionalArgsField()
           
static int getAdditionalArgsFieldId()
          Get the field id for 'additionalArgs' This method can be used to set field interests.
 String[] getAliases()
          Gets the value of 'aliases' If the field is not set this method will return null.
 String[] getAliasesEmptyIfNull()
          Gets the value of 'aliases' or an empty array if the value is null or not set.
static int getAliasesFieldId()
          Get the field id for 'aliases' This method can be used to set field interests.
 XStringIterator getAliasesIterator()
          Gets the value of 'aliases' as iterator of values.
 SrvMonArgumentDescription[] getArguments()
          Gets the value of 'arguments' If the field is not set this method will return null.
 SrvMonArgumentDescription[] getArgumentsEmptyIfNull()
          Gets the value of 'arguments' or an empty array if the value is null or not set.
static int getArgumentsFieldId()
          Get the field id for 'arguments' This method can be used to set field interests.
 XIterator<SrvMonArgumentDescription> getArgumentsIterator()
          Gets the value of 'arguments' as iterator of values.
 PktBuffer getBackingBuffer()
           
 String getDescription()
          Gets the value of 'description' Field Description The command description
 com.neeve.xbuf.XbufStringField getDescriptionField()
           
static int getDescriptionFieldId()
          Get the field id for 'description' This method can be used to set field interests.
<T extends XString>
T
getDescriptionTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getDescriptionTo(XString val)
          Copies the value of 'description' into the provided XString.
 XString getDescriptionUnsafe()
          Gets the raw value of 'description'.
static com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()
           
 String getDisplayName()
          Gets the value of 'displayName' Field Description The display name for the command.
 com.neeve.xbuf.XbufStringField getDisplayNameField()
           
static int getDisplayNameFieldId()
          Get the field id for 'displayName' This method can be used to set field interests.
<T extends XString>
T
getDisplayNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getDisplayNameTo(XString val)
          Copies the value of 'displayName' into the provided XString.
 XString getDisplayNameUnsafe()
          Gets the raw value of 'displayName'.
 String[] getGroup()
          Gets the value of 'group' If the field is not set this method will return null.
 String[] getGroupEmptyIfNull()
          Gets the value of 'group' or an empty array if the value is null or not set.
static int getGroupFieldId()
          Get the field id for 'group' This method can be used to set field interests.
 XStringIterator getGroupIterator()
          Gets the value of 'group' as iterator of values.
 boolean getHidden()
          Gets the value of 'hidden' Field Description Whether or not the command is hidden/internal
 com.neeve.xbuf.XbufVariableBooleanField getHiddenField()
           
static int getHiddenFieldId()
          Get the field id for 'hidden' This method can be used to set field interests.
 boolean getIsReadOnly()
           
 String getName()
          Gets the value of 'name' Field Description The command name
 com.neeve.xbuf.XbufStringField getNameField()
           
static int getNameFieldId()
          Get the field id for 'name' This method can be used to set field interests.
<T extends XString>
T
getNameTo(XString.Factory<T> factory)
          Copies the value of this String field into a new XString from the given factory.
 void getNameTo(XString val)
          Copies the value of 'name' into the provided XString.
 XString getNameUnsafe()
          Gets the raw value of 'name'.
 SrvMonOptionDescription[] getOptions()
          Gets the value of 'options' If the field is not set this method will return null.
 SrvMonOptionDescription[] getOptionsEmptyIfNull()
          Gets the value of 'options' or an empty array if the value is null or not set.
static int getOptionsFieldId()
          Get the field id for 'options' This method can be used to set field interests.
 XIterator<SrvMonOptionDescription> getOptionsIterator()
          Gets the value of 'options' as iterator of values.
 int getOwnerCount()
           
 UtlPool<SrvMonCommandDescription> getPool()
          Get a pool item's pool.
 SrvMonReturnType getReturnType()
          Gets the value of 'returnType' Field Description The return type of this command
 com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> getReturnTypeField()
           
static int getReturnTypeFieldId()
          Get the field id for 'returnType' This method can be used to set field interests.
 int getSerializeToNativeLength()
           
 void getValidationErrors(List<XString> results, String errorPrefix)
          Collects validation errors into the provided list.
 short getXRogType()
           
 com.neeve.xbuf.XbufVariableShortField getXRogTypeField()
           
static int getXRogTypeFieldId()
          Get the field id for 'xRogType' This method can be used to set field interests.
 boolean hasAdditionalArgs()
          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)
 boolean hasAdditionalArgsDescription()
          Checks for the presence of 'additionalArgsDescription' Field Description The description that describes how additional arguments should be specified.
 boolean hasAdditionalArgsDisplayName()
          Checks for the presence of 'additionalArgsDisplayName' Field Description The display name to user for additional arguments.
 boolean hasDescription()
          Checks for the presence of 'description' Field Description The command description
 boolean hasDisplayName()
          Checks for the presence of 'displayName' Field Description The display name for the command.
 boolean hasHidden()
          Checks for the presence of 'hidden' Field Description Whether or not the command is hidden/internal
 boolean hasName()
          Checks for the presence of 'name' Field Description The command name
 boolean hasReturnType()
          Checks for the presence of 'returnType' Field Description The return type of this command
 boolean hasXRogType()
           
 SrvMonCommandDescription init()
          Initialize an item.
 boolean isBufferBacked()
           
 boolean isDirty()
           
 boolean isReferenceCounted()
           
 boolean isValid()
          Tests if this object has any validation errors.
 void lendAdditionalArgsDescription(XString val)
          Sets the value of 'additionalArgsDescription' Field Description The description that describes how additional arguments should be specified.
 void lendAdditionalArgsDisplayName(XString val)
          Sets the value of 'additionalArgsDisplayName' Field Description The display name to user for additional arguments.
 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' 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.
 void lendArgumentsFrom(XIterator<SrvMonArgumentDescription> val)
          Sets the value of 'arguments' by lending the values from the provided iterator.
 void lendDescription(XString val)
          Sets the value of 'description' Field Description The command description
 void lendDisplayName(XString val)
          Sets the value of 'displayName' Field Description The display name for the command.
 void lendName(XString val)
          Sets the value of 'name' Field Description The command name
 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' 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.
 void lendOptionsFrom(XIterator<SrvMonOptionDescription> val)
          Sets the value of 'options' by lending the values from the provided iterator.
static void optimizeFor(int val)
           
 byte[] serializeToByteArray()
           
 ByteBuffer serializeToByteBuffer()
           
 com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)
           
 int serializeToNative(long address, int addressOffset)
           
 void setAdditionalArgs(boolean val)
          Sets the value of 'additionalArgs' Field Description Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs)
 void setAdditionalArgsDescription(String val)
          Sets the value of 'additionalArgsDescription' Field Description The description that describes how additional arguments should be specified.
 void setAdditionalArgsDescriptionFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setAdditionalArgsDescriptionFrom(com.neeve.xbuf.XbufStringField val)
           
 void setAdditionalArgsDescriptionFrom(XString val)
          Copies the provided XString value into this object's 'additionalArgsDescription'.
 void setAdditionalArgsDisplayName(String val)
          Sets the value of 'additionalArgsDisplayName' Field Description The display name to user for additional arguments.
 void setAdditionalArgsDisplayNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setAdditionalArgsDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setAdditionalArgsDisplayNameFrom(XString val)
          Copies the provided XString value into this object's 'additionalArgsDisplayName'.
 void setAdditionalArgsFrom(com.neeve.xbuf.XbufVariableBooleanField val)
           
 void setAliases(String[] val)
          Sets the value of 'aliases' Field Description The command alias
 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' Field Description The available arguments to the command
 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' Field Description The command description
 void setDescriptionFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setDescriptionFrom(com.neeve.xbuf.XbufStringField val)
           
 void setDescriptionFrom(XString val)
          Copies the provided XString value into this object's 'description'.
static void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)
           
 void setDisplayName(String val)
          Sets the value of 'displayName' Field Description The display name for the command.
 void setDisplayNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setDisplayNameFrom(XString val)
          Copies the provided XString value into this object's 'displayName'.
static void setFieldInterest(List<Integer> fieldIds)
           
 void setGroup(String[] val)
          Sets the value of 'group' Field Description The group hierarchy this command belongs to.
 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' Field Description Whether or not the command is hidden/internal
 void setHiddenFrom(com.neeve.xbuf.XbufVariableBooleanField val)
           
 void setName(String val)
          Sets the value of 'name' Field Description The command name
 void setNameFrom(long val)
          Sets the value of this String field to the given numeric value.
 void setNameFrom(com.neeve.xbuf.XbufStringField val)
           
 void setNameFrom(XString val)
          Copies the provided XString value into this object's 'name'.
 void setOptions(SrvMonOptionDescription[] val)
          Sets the value of 'options' Field Description The command 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' Field Description The return type of this command
 void setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val)
           
 void setXRogType(short val)
           
 void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)
           
 void sync()
           
 void syncFieldBitmask()
           
 SrvMonArgumentDescription[] takeArguments()
          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.
 SrvMonOptionDescription[] takeOptions()
          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.
 String toString()
           
 
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
A preallocated empty array used to avoid garbage when returning empty arrays of this type.

Constructor Detail

SrvMonCommandDescription

public SrvMonCommandDescription()

SrvMonCommandDescription

public SrvMonCommandDescription(int initialBackingBufferSize)
Method Detail

create

public static SrvMonCommandDescription create()

createFromSerializedXbufContainer

public static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer,
                                                                         com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFromSerializedXbufContainer

public static SrvMonCommandDescription createFromSerializedXbufContainer(byte[] serializedContainer)

createFrom

public static SrvMonCommandDescription createFrom(byte[] serializedContainer,
                                                  com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

createFrom

public static SrvMonCommandDescription createFrom(byte[] serializedContainer)

setDesyncPolicy

public static final void setDesyncPolicy(com.neeve.xbuf.XbufDesyncPolicy val)

getDesyncPolicy

public static final com.neeve.xbuf.XbufDesyncPolicy getDesyncPolicy()

setFieldInterest

public static final void setFieldInterest(List<Integer> fieldIds)

clearContent

public final void clearContent()

syncFieldBitmask

public final void syncFieldBitmask()

desyncFieldBitmask

public final void desyncFieldBitmask()

getBackingBuffer

public final PktBuffer getBackingBuffer()

optimizeFor

public static final void optimizeFor(int val)

setAsReadOnly

public final void setAsReadOnly()

getIsReadOnly

public final boolean getIsReadOnly()

getXRogTypeFieldId

public static final int getXRogTypeFieldId()
Get the field id for 'xRogType'

This method can be used to set field interests.

See Also:
getXRogType()

setXRogType

public final void setXRogType(short val)

getXRogType

public final short getXRogType()

setXRogTypeFrom

public final void setXRogTypeFrom(com.neeve.xbuf.XbufVariableShortField val)

getXRogTypeField

public final com.neeve.xbuf.XbufVariableShortField getXRogTypeField()

hasXRogType

public final boolean hasXRogType()

clearXRogType

public final void clearXRogType()

getAdditionalArgsFieldId

public static final int getAdditionalArgsFieldId()
Get the field id for 'additionalArgs'

This method can be used to set field interests.

See Also:
getAdditionalArgs()

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)

setAdditionalArgsFrom

public final void setAdditionalArgsFrom(com.neeve.xbuf.XbufVariableBooleanField val)

getAdditionalArgsField

public final com.neeve.xbuf.XbufVariableBooleanField getAdditionalArgsField()

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()
Get the field id for 'returnType'

This method can be used to set field interests.

See Also:
getReturnType()

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.

setReturnTypeFrom

public final void setReturnTypeFrom(com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> val)

getReturnTypeField

public final com.neeve.xbuf.XbufVariableEnumField<SrvMonReturnType> getReturnTypeField()

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()
Get the field id for 'hidden'

This method can be used to set field interests.

See Also:
getHidden()

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

setHiddenFrom

public final void setHiddenFrom(com.neeve.xbuf.XbufVariableBooleanField val)

getHiddenField

public final com.neeve.xbuf.XbufVariableBooleanField getHiddenField()

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()
Get the field id for 'name'

This method can be used to set field interests.

See Also:
getName()

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
Sets the value of 'name'

Field Description

The command name

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(XString.Factory<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()

setNameFrom

public final void setNameFrom(com.neeve.xbuf.XbufStringField val)

getNameField

public final com.neeve.xbuf.XbufStringField getNameField()

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()
Get the field id for 'aliases'

This method can be used to set field interests.

See Also:
getAliases()

createAliasesFieldBuffer

public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createAliasesFieldBuffer(int initialBufferLength,
                                                                                          boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.

For example the following would result in a bulk transfer from this message

 XbufRepeatedStringFieldBuffer preallocated = SrvMonCommandDescription.createAliasesFieldBuffer(1024, true);
 // The following would then result in a buffer copy without any iteration:
 preallocated.setValue(inboundMessage.getAliasesIterator());
 // The preallocated bulk copied values can then be transfered to an outbound message:
 outboundMessage.setAliases.setValueFrom(preallocated);

Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.

Parameters:
initialBufferLength - the initial size of the underlying backing buffer.
isNative - Whether the backing buffer should be a native or heap buffer.

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()
Get the field id for 'description'

This method can be used to set field interests.

See Also:
getDescription()

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
Sets the value of 'description'

Field Description

The command description

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(XString.Factory<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()

setDescriptionFrom

public final void setDescriptionFrom(com.neeve.xbuf.XbufStringField val)

getDescriptionField

public final com.neeve.xbuf.XbufStringField getDescriptionField()

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()
Get the field id for 'arguments'

This method can be used to set field interests.

See Also:
getArguments()

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.

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.

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.

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

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 this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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()
Get the field id for 'options'

This method can be used to set field interests.

See Also:
getOptions()

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.

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.

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.

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

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 this object intends to keep beyond the lifespan. of this object (unless the element is lent to another object in which that object will acquire it then).

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()
Get the field id for 'displayName'

This method can be used to set field interests.

See Also:
getDisplayName()

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
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:
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(XString.Factory<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()

setDisplayNameFrom

public final void setDisplayNameFrom(com.neeve.xbuf.XbufStringField val)

getDisplayNameField

public final com.neeve.xbuf.XbufStringField getDisplayNameField()

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()
Get the field id for 'additionalArgsDescription'

This method can be used to set field interests.

See Also:
getAdditionalArgsDescription()

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
Sets the value of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

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(XString.Factory<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()

setAdditionalArgsDescriptionFrom

public final void setAdditionalArgsDescriptionFrom(com.neeve.xbuf.XbufStringField val)

getAdditionalArgsDescriptionField

public final com.neeve.xbuf.XbufStringField getAdditionalArgsDescriptionField()

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()
Get the field id for 'additionalArgsDisplayName'

This method can be used to set field interests.

See Also:
getAdditionalArgsDisplayName()

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
Sets the value of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

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(XString.Factory<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()

setAdditionalArgsDisplayNameFrom

public final void setAdditionalArgsDisplayNameFrom(com.neeve.xbuf.XbufStringField val)

getAdditionalArgsDisplayNameField

public final com.neeve.xbuf.XbufStringField getAdditionalArgsDisplayNameField()

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()
Get the field id for 'group'

This method can be used to set field interests.

See Also:
getGroup()

createGroupFieldBuffer

public static final com.neeve.xbuf.XbufRepeatedStringFieldBuffer createGroupFieldBuffer(int initialBufferLength,
                                                                                        boolean isNative)
Returns a wrapped buffer that can be used for doing an efficient bulk copy from an XIterator returned for this field.

For example the following would result in a bulk transfer from this message

 XbufRepeatedStringFieldBuffer preallocated = SrvMonCommandDescription.createGroupFieldBuffer(1024, true);
 // The following would then result in a buffer copy without any iteration:
 preallocated.setValue(inboundMessage.getGroupIterator());
 // The preallocated bulk copied values can then be transfered to an outbound message:
 outboundMessage.setGroup.setValueFrom(preallocated);

Bulk transfer from the backing buffer may only possible between two fields with the same id (protobuf tag) because the bulk transfered bytes are in protobuf wire format which for most repeated fields encode the field's tag for each element.

Parameters:
initialBufferLength - the initial size of the underlying backing buffer.
isNative - Whether the backing buffer should be a native or heap buffer.

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[])

isDirty

public final boolean isDirty()

createSchema

public static final com.neeve.xbuf.XbufSchema createSchema()

serializeToByteArray

public final byte[] serializeToByteArray()

serializeToByteBuffer

public final ByteBuffer serializeToByteBuffer()

serializeToIOBuffer

public final com.neeve.io.IOBuffer serializeToIOBuffer(boolean useNative)

isBufferBacked

public final boolean isBufferBacked()

getSerializeToNativeLength

public final int getSerializeToNativeLength()

serializeToNative

public final int serializeToNative(long address,
                                   int addressOffset)

deserializeFromIOElasticBuffer

public final SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                     int offset,
                                                                     int length,
                                                                     com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromIOElasticBuffer

public final SrvMonCommandDescription deserializeFromIOElasticBuffer(com.neeve.io.IOElasticBuffer buffer,
                                                                     int offset,
                                                                     int length)

deserializeFromByteArray

public final SrvMonCommandDescription deserializeFromByteArray(byte[] array,
                                                               com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteArray

public final SrvMonCommandDescription deserializeFromByteArray(byte[] array)

deserializeFromByteBuffer

public final SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer,
                                                                com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromByteBuffer

public final SrvMonCommandDescription deserializeFromByteBuffer(ByteBuffer buffer)

deserializeFromNative

public final SrvMonCommandDescription deserializeFromNative(long address,
                                                            int offset,
                                                            int length,
                                                            com.neeve.xbuf.XbufDesyncPolicy desyncPolicy)

deserializeFromNative

public final SrvMonCommandDescription deserializeFromNative(long address,
                                                            int offset,
                                                            int length)

sync

public final void sync()

desync

public final int desync(PktBuffer buffer,
                        int pos,
                        boolean frameOnly)
Specified by:
desync in interface com.neeve.xbuf.IXbufDesyncer

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)

Specified by:
getPool in interface UtlPool.Item<SrvMonCommandDescription>
Returns:
the pool set using UtlPool.Item.setPool(com.neeve.util.UtlPool)

isReferenceCounted

public final boolean isReferenceCounted()

acquire

public final SrvMonCommandDescription acquire()

getOwnerCount

public final int getOwnerCount()

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:

Overrides:
clone in class Object

copy

public final SrvMonCommandDescription copy()
Creates a copy of this SrvMonCommandDescription.

The copy copies primitive, enum and embedded entity fields into the returned copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonCommandDescription's embedded entity fields.

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

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Returns:
The copied entity.

copyInto

public final void copyInto(SrvMonCommandDescription copy)
Copies the contents of this SrvMonCommandDescription into the target.

The copy clears the target's contents and copies primitive, enum and embedded entity fields into the provided copy. Each embedded entity field is cloned so that modifications made to the copy's embedded entity fields do not affect this SrvMonCommandDescription's embedded entity fields.

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

Xbuf Pass-through Fields

When backed by a buffer, this operation copies the underlying buffer which means that if the message was deserialized from with unrecognized fields, such fields will be preserved in the copy as well.

Parameters:
copy - The target into which to copy.

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
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2016 Neeve Research, LLC. All Rights Reserved.