com.neeve.server.mon.cnc
Interface ISrvMonCommandDescription

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonCommandDescription

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

Describes a command

Method Summary

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	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
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.
<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.
<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'.
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.
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.
XIterator<SrvMonArgumentDescription>	getArgumentsIterator() Gets the value of 'arguments' as iterator of values.
String	getDescription() Gets the value of 'description' Field Description The command description
<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'.
String	getDisplayName() Gets the value of 'displayName' Field Description The display name for the command.
<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.
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
String	getName() Gets the value of 'name' Field Description The command name
<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.
XIterator<SrvMonOptionDescription>	getOptionsIterator() Gets the value of 'options' as iterator of values.
SrvMonReturnType	getReturnType() Gets the value of 'returnType' Field Description The return type of this command
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
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.
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(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(XString val) Copies the provided XString value into this object's 'additionalArgsDisplayName'.
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	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(XString val) Copies the provided XString value into this object's 'description'.
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(XString val) Copies the provided XString value into this object's 'displayName'.
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	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(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.
void	setReturnType(SrvMonReturnType val) Sets the value of 'returnType' Field Description The return type of this command
SrvMonArgumentDescription[]	takeArguments() Takes the value of 'arguments' Field Description The available arguments to the command NOTE: A nested entity reference returned by 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 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.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setAdditionalArgs

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)

Parameters:

val - The value to set.

getAdditionalArgs

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)

Returns:

Whether or not this command will accept all arguments not otherwise described as an additional string argument (varargs)

clearAdditionalArgs

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)

See Also:

setAdditionalArgs(boolean)

hasAdditionalArgs

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)

See Also:

getAdditionalArgs()

setReturnType

void setReturnType(SrvMonReturnType val)

Sets the value of 'returnType'

Field Description

The return type of this command

Parameters:

val - The value to set.

getReturnType

SrvMonReturnType getReturnType()

Gets the value of 'returnType'

Field Description

The return type of this command

Returns:

The return type of this command

clearReturnType

void clearReturnType()

Clears the value of 'returnType'

Field Description

The return type of this command

See Also:

setReturnType(SrvMonReturnType)

hasReturnType

boolean hasReturnType()

Checks for the presence of 'returnType'

Field Description

The return type of this command

See Also:

getReturnType()

setHidden

void setHidden(boolean val)

Sets the value of 'hidden'

Field Description

Whether or not the command is hidden/internal

Parameters:

val - The value to set.

getHidden

boolean getHidden()

Gets the value of 'hidden'

Field Description

Whether or not the command is hidden/internal

Returns:

Whether or not the command is hidden/internal

clearHidden

void clearHidden()

Clears the value of 'hidden'

Field Description

Whether or not the command is hidden/internal

See Also:

setHidden(boolean)

hasHidden

boolean hasHidden()

Checks for the presence of 'hidden'

Field Description

Whether or not the command is hidden/internal

See Also:

getHidden()

setName

void setName(String val)

Sets the value of 'name'

Field Description

The command name

Parameters:

val - The value to set.

getName

String getName()

Gets the value of 'name'

Field Description

The command name

Returns:

The command name

lendName

void lendName(XString val)

Sets the value of 'name'

Field Description

The command name

Parameters:

val - The value to set.

setNameFrom

void setNameFrom(long val)

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

Field Description

The command name

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

getNameTo

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

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setNameFrom

void setNameFrom(XString val)

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 setName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getNameTo

void getNameTo(XString val)

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 getName() bec because it can avoid decoding the value into an String.

See Also:

getName()

getNameUnsafe

XString getNameUnsafe()

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.

Returns:

the field's raw value

See Also:

getName()

clearName

void clearName()

Clears the value of 'name'

Field Description

The command name

See Also:

setName(String)

hasName

boolean hasName()

Checks for the presence of 'name'

Field Description

The command name

See Also:

getName()

setAliases

void setAliases(String[] val)

Sets the value of 'aliases'

Field Description

The command alias

Parameters:

val - The value to set.

setAliasesFrom

void setAliasesFrom(XIterator<String> val)

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 setAliases(String[]) with a value of null.

Parameters:

val - the values to set.

addAliases

void addAliases(String val)

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

Parameters:

val - the value to add.

getAliasesIterator

XStringIterator getAliasesIterator()

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

Returns:

An XStringIterator containing this field values.

getAliases

String[] getAliases()

Gets the value of 'aliases'

If the field is not set this method will return null.

Field Description

The command alias

Returns:

The command alias If the field is not set this method will return null.

getAliasesEmptyIfNull

String[] getAliasesEmptyIfNull()

Gets the value of 'aliases' or an empty array if the value is null or not set.

Field Description

The command alias

Returns:

The command alias or an empty array if null if not set.

See Also:

getAliases()

clearAliases

void clearAliases()

Clears the value of 'aliases'

Field Description

The command alias

See Also:

setAliases(String[])

setDescription

void setDescription(String val)

Sets the value of 'description'

Field Description

The command description

Parameters:

val - The value to set.

getDescription

String getDescription()

Gets the value of 'description'

Field Description

The command description

Returns:

The command description

lendDescription

void lendDescription(XString val)

Sets the value of 'description'

Field Description

The command description

Parameters:

val - The value to set.

setDescriptionFrom

void setDescriptionFrom(long val)

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

Field Description

The command description

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

getDescriptionTo

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

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setDescriptionFrom

void setDescriptionFrom(XString val)

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 setDescription(String) because it avoids encoding the value into a String if the given XString is already encoded.

getDescriptionTo

void getDescriptionTo(XString val)

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 getDescription() bec because it can avoid decoding the value into an String.

See Also:

getDescription()

getDescriptionUnsafe

XString getDescriptionUnsafe()

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.

Returns:

the field's raw value

See Also:

getDescription()

clearDescription

void clearDescription()

Clears the value of 'description'

Field Description

The command description

See Also:

setDescription(String)

hasDescription

boolean hasDescription()

Checks for the presence of 'description'

Field Description

The command description

See Also:

getDescription()

setArguments

void setArguments(SrvMonArgumentDescription[] val)

Sets the value of 'arguments'

Field Description

The available arguments to the command

Parameters:

val - The value to set.

setArgumentsFrom

void setArgumentsFrom(XIterator<SrvMonArgumentDescription> val)

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 setArguments(SrvMonArgumentDescription[]) with a value of null.

Parameters:

val - the values to set.

lendArgumentsFrom

void lendArgumentsFrom(XIterator<SrvMonArgumentDescription> val)

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 setArguments(SrvMonArgumentDescription[]) with a value of null.

Parameters:

val - the values to set.

addArguments

void addArguments(SrvMonArgumentDescription val)

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

Parameters:

val - the value to add.

lendArguments

void lendArguments(SrvMonArgumentDescription val)

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

Parameters:

val - the value to add.

getArgumentsIterator

XIterator<SrvMonArgumentDescription> getArgumentsIterator()

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

Returns:

An iterator containing this field values.

lendArguments

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. 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.

Parameters:

val - the value to 'lend' to lend.

getArguments

SrvMonArgumentDescription[] getArguments()

Gets the value of 'arguments'

If the field is not set this method will return null.

Field Description

The available arguments to the command

Returns:

The available arguments to the command If the field is not set this method will return null.

getArgumentsEmptyIfNull

SrvMonArgumentDescription[] getArgumentsEmptyIfNull()

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

Returns:

The available arguments to the command or an empty array if null if not set.

See Also:

getArguments()

takeArguments

SrvMonArgumentDescription[] takeArguments()

Takes the value of 'arguments'

Field Description

The available arguments to the command

NOTE:
A nested entity reference returned by 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.

Returns:

a 'taken' reference to the field or null if the field is not set.

clearArguments

void clearArguments()

Clears the value of 'arguments'

Field Description

The available arguments to the command

See Also:

setArguments(SrvMonArgumentDescription[])

setOptions

void setOptions(SrvMonOptionDescription[] val)

Sets the value of 'options'

Field Description

The command options

Parameters:

val - The value to set.

setOptionsFrom

void setOptionsFrom(XIterator<SrvMonOptionDescription> val)

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 setOptions(SrvMonOptionDescription[]) with a value of null.

Parameters:

val - the values to set.

lendOptionsFrom

void lendOptionsFrom(XIterator<SrvMonOptionDescription> val)

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 setOptions(SrvMonOptionDescription[]) with a value of null.

Parameters:

val - the values to set.

addOptions

void addOptions(SrvMonOptionDescription val)

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

Parameters:

val - the value to add.

lendOptions

void lendOptions(SrvMonOptionDescription val)

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

Parameters:

val - the value to add.

getOptionsIterator

XIterator<SrvMonOptionDescription> getOptionsIterator()

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

Returns:

An iterator containing this field values.

lendOptions

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. 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.

Parameters:

val - the value to 'lend' to lend.

getOptions

SrvMonOptionDescription[] getOptions()

Gets the value of 'options'

If the field is not set this method will return null.

Field Description

The command options

Returns:

The command options If the field is not set this method will return null.

getOptionsEmptyIfNull

SrvMonOptionDescription[] getOptionsEmptyIfNull()

Gets the value of 'options' or an empty array if the value is null or not set.

Field Description

The command options

Returns:

The command options or an empty array if null if not set.

See Also:

getOptions()

takeOptions

SrvMonOptionDescription[] takeOptions()

Takes the value of 'options'

Field Description

The command options

NOTE:
A nested entity reference returned by 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.

Returns:

a 'taken' reference to the field or null if the field is not set.

clearOptions

void clearOptions()

Clears the value of 'options'

Field Description

The command options

See Also:

setOptions(SrvMonOptionDescription[])

setDisplayName

void setDisplayName(String val)

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.

Parameters:

val - The value to set.

getDisplayName

String getDisplayName()

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.

Returns:

The display name for the command.

lendDisplayName

void lendDisplayName(XString val)

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.

Parameters:

val - The value to set.

setDisplayNameFrom

void setDisplayNameFrom(long val)

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 setDisplayName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getDisplayNameTo

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

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setDisplayNameFrom

void setDisplayNameFrom(XString val)

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 setDisplayName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getDisplayNameTo

void getDisplayNameTo(XString val)

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 getDisplayName() bec because it can avoid decoding the value into an String.

See Also:

getDisplayName()

getDisplayNameUnsafe

XString getDisplayNameUnsafe()

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.

Returns:

the field's raw value

See Also:

getDisplayName()

clearDisplayName

void clearDisplayName()

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.

See Also:

setDisplayName(String)

hasDisplayName

boolean hasDisplayName()

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.

See Also:

getDisplayName()

setAdditionalArgsDescription

void setAdditionalArgsDescription(String val)

Sets the value of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

Parameters:

val - The value to set.

getAdditionalArgsDescription

String getAdditionalArgsDescription()

Gets the value of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

Returns:

The description that describes how additional arguments should be specified.

lendAdditionalArgsDescription

void lendAdditionalArgsDescription(XString val)

Sets the value of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

Parameters:

val - The value to set.

setAdditionalArgsDescriptionFrom

void setAdditionalArgsDescriptionFrom(long val)

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 setAdditionalArgsDescription(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getAdditionalArgsDescriptionTo

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

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setAdditionalArgsDescriptionFrom

void setAdditionalArgsDescriptionFrom(XString val)

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 setAdditionalArgsDescription(String) because it avoids encoding the value into a String if the given XString is already encoded.

getAdditionalArgsDescriptionTo

void getAdditionalArgsDescriptionTo(XString val)

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 getAdditionalArgsDescription() bec because it can avoid decoding the value into an String.

See Also:

getAdditionalArgsDescription()

getAdditionalArgsDescriptionUnsafe

XString getAdditionalArgsDescriptionUnsafe()

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.

Returns:

the field's raw value

See Also:

getAdditionalArgsDescription()

clearAdditionalArgsDescription

void clearAdditionalArgsDescription()

Clears the value of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

See Also:

setAdditionalArgsDescription(String)

hasAdditionalArgsDescription

boolean hasAdditionalArgsDescription()

Checks for the presence of 'additionalArgsDescription'

Field Description

The description that describes how additional arguments should be specified.

See Also:

getAdditionalArgsDescription()

setAdditionalArgsDisplayName

void setAdditionalArgsDisplayName(String val)

Sets the value of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

Parameters:

val - The value to set.

getAdditionalArgsDisplayName

String getAdditionalArgsDisplayName()

Gets the value of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

Returns:

The display name to user for additional arguments.

lendAdditionalArgsDisplayName

void lendAdditionalArgsDisplayName(XString val)

Sets the value of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

Parameters:

val - The value to set.

setAdditionalArgsDisplayNameFrom

void setAdditionalArgsDisplayNameFrom(long val)

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 setAdditionalArgsDisplayName(String). with Long.valueOf(val).toString(), except that using this method is a zero garbage operation for Xbuf encoding.

getAdditionalArgsDisplayNameTo

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

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;

Parameters:

factory - The factory from which to get the XString to copy into and return

Returns:

a new XString from the provided factory if this field is set or null.

Throws:

NullPointerException - if the provided factory is null

setAdditionalArgsDisplayNameFrom

void setAdditionalArgsDisplayNameFrom(XString val)

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 setAdditionalArgsDisplayName(String) because it avoids encoding the value into a String if the given XString is already encoded.

getAdditionalArgsDisplayNameTo

void getAdditionalArgsDisplayNameTo(XString val)

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 getAdditionalArgsDisplayName() bec because it can avoid decoding the value into an String.

See Also:

getAdditionalArgsDisplayName()

getAdditionalArgsDisplayNameUnsafe

XString getAdditionalArgsDisplayNameUnsafe()

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.

Returns:

the field's raw value

See Also:

getAdditionalArgsDisplayName()

clearAdditionalArgsDisplayName

void clearAdditionalArgsDisplayName()

Clears the value of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

See Also:

setAdditionalArgsDisplayName(String)

hasAdditionalArgsDisplayName

boolean hasAdditionalArgsDisplayName()

Checks for the presence of 'additionalArgsDisplayName'

Field Description

The display name to user for additional arguments.

See Also:

getAdditionalArgsDisplayName()

setGroup

void setGroup(String[] val)

Sets the value of 'group'

Field Description

The group hierarchy this command belongs to.

Parameters:

val - The value to set.

setGroupFrom

void setGroupFrom(XIterator<String> val)

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 setGroup(String[]) with a value of null.

Parameters:

val - the values to set.

addGroup

void addGroup(String val)

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.

Parameters:

val - the value to add.

getGroupIterator

XStringIterator getGroupIterator()

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.

Returns:

An XStringIterator containing this field values.

getGroup

String[] getGroup()

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.

Returns:

The group hierarchy this command belongs to. If the field is not set this method will return null.

getGroupEmptyIfNull

String[] getGroupEmptyIfNull()

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.

Returns:

The group hierarchy this command belongs to. or an empty array if null if not set.

See Also:

getGroup()

clearGroup

void clearGroup()

Clears the value of 'group'

Field Description

The group hierarchy this command belongs to.

See Also:

setGroup(String[])