com.neeve.server.mon.cnc

Interface ISrvMonArgumentDescription

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonArgumentDescription

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonArgumentDescription
extends IRogValidatable

Describes a command argument.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonCncFactory

ADM Field Summary

Field	Type	Id	Description
defaultValue	String	4	The default value for the argument when not specified ... or not set if no default.
description	String	7	The command description.
displayName	String	8	The display name for the argument. If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.
name	String	1	The command name.
position	Short	2	The position at which the argument must be specified.
required	Boolean	3	Whether or not the argument is required.
type	SrvMonArgumentType	5	Describes the type of the argument.
validValues	String[]	6	When set restricts the set of valid values for the command.

Method Summary

Methods

Modifier and Type	Method and Description
void	addValidValues(String val) Adds the provided value to the list of 'validValues' values.
void	clearDefaultValue() Clears the value of 'defaultValue'.
void	clearDescription() Clears the value of 'description'.
void	clearDisplayName() Clears the value of 'displayName'.
void	clearName() Clears the value of 'name'.
void	clearPosition() Clears the value of 'position'.
void	clearRequired() Clears the value of 'required'.
void	clearType() Clears the value of 'type'.
void	clearValidValues() Clears the value of 'validValues'.
String	getDefaultValue() Gets the value of 'defaultValue'.
<T extends XString> T	getDefaultValueTo(XString.Factory<T> factory) Copies the value of this String field into a new XString from the given factory.
void	getDefaultValueTo(XString val) Copies the value of 'defaultValue' into the provided XString.
XString	getDefaultValueUnsafe() Gets the raw value of 'defaultValue'.
String	getDescription() Gets the value of 'description'.
<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'.
<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	getName() Gets the value of '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'.
short	getPosition() Gets the value of 'position'.
boolean	getRequired() Gets the value of 'required'.
SrvMonArgumentType	getType() Gets the value of 'type'.
String[]	getValidValues() Gets the value of 'validValues'.
String[]	getValidValuesEmptyIfNull() Gets the value of 'validValues' or an empty array if the value is null or not set.
XStringIterator	getValidValuesIterator() Gets the value of 'validValues' as iterator of values.
boolean	hasDefaultValue() Checks for the presence of 'defaultValue'.
boolean	hasDescription() Checks for the presence of 'description'.
boolean	hasDisplayName() Checks for the presence of 'displayName'.
boolean	hasName() Checks for the presence of 'name'.
boolean	hasPosition() Checks for the presence of 'position'.
boolean	hasRequired() Checks for the presence of 'required'.
boolean	hasType() Checks for the presence of 'type'.
void	lendDefaultValue(XString val) Lends the value of 'defaultValue' to this object.
void	lendDescription(XString val) Lends the value of 'description' to this object.
void	lendDisplayName(XString val) Lends the value of 'displayName' to this object.
void	lendName(XString val) Lends the value of 'name' to this object.
void	setDefaultValue(String val) Sets the value of 'defaultValue'.
void	setDefaultValueFrom(long val) Sets the value of this String field to the given numeric value.
void	setDefaultValueFrom(XString val) Copies the provided XString value into this object's 'defaultValue'.
void	setDescription(String val) Sets the value of 'description'.
void	setDescriptionFrom(long val) Sets the value of this String field to the given numeric value.
void	setDescriptionFrom(XString val) Copies the provided XString value into this object's 'description'.
void	setDisplayName(String val) Sets the value of 'displayName'.
void	setDisplayNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setDisplayNameFrom(XString val) Copies the provided XString value into this object's 'displayName'.
void	setName(String val) Sets the value of 'name'.
void	setNameFrom(long val) Sets the value of this String field to the given numeric value.
void	setNameFrom(XString val) Copies the provided XString value into this object's 'name'.
void	setPosition(short val) Sets the value of 'position'.
void	setRequired(boolean val) Sets the value of 'required'.
void	setType(SrvMonArgumentType val) Sets the value of 'type'.
void	setValidValues(String[] val) Sets the value of 'validValues'.
void	setValidValuesFrom(XIterator<String> val) Sets the value of 'validValues' using the values from the provided iterator.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setPosition

void setPosition(short val)

Sets the value of 'position'.

Field Description

The position at which the argument must be specified.

Parameters:

val - The value to set.

getPosition

short getPosition()

Gets the value of 'position'.

Field Description

The position at which the argument must be specified.

Returns:

The position at which the argument must be specified.

clearPosition

void clearPosition()

Clears the value of 'position'.

Field Description

The position at which the argument must be specified.

See Also:

setPosition(short)

hasPosition

boolean hasPosition()

Checks for the presence of 'position'.

Field Description

The position at which the argument must be specified.

See Also:

getPosition()

setRequired

void setRequired(boolean val)

Sets the value of 'required'.

Field Description

Whether or not the argument is required.

Parameters:

val - The value to set.

getRequired

boolean getRequired()

Gets the value of 'required'.

Field Description

Whether or not the argument is required.

Returns:

Whether or not the argument is required.

clearRequired

void clearRequired()

Clears the value of 'required'.

Field Description

Whether or not the argument is required.

See Also:

setRequired(boolean)

hasRequired

boolean hasRequired()

Checks for the presence of 'required'.

Field Description

Whether or not the argument is required.

See Also:

getRequired()

setType

void setType(SrvMonArgumentType val)

Sets the value of 'type'.

Field Description

Describes the type of the argument.

Parameters:

val - The value to set.

getType

SrvMonArgumentType getType()

Gets the value of 'type'.

Field Description

Describes the type of the argument.

Returns:

Describes the type of the argument.

clearType

void clearType()

Clears the value of 'type'.

Field Description

Describes the type of the argument.

See Also:

setType(SrvMonArgumentType)

hasType

boolean hasType()

Checks for the presence of 'type'.

Field Description

Describes the type of the argument.

See Also:

getType()

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)

Lends the value of 'name' to this object.

This method is equivalent to setName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The command name.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

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

setDefaultValue

void setDefaultValue(String val)

Sets the value of 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

Parameters:

val - The value to set.

getDefaultValue

String getDefaultValue()

Gets the value of 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

Returns:

The default value for the argument when not specified ... or not set if no default.

lendDefaultValue

void lendDefaultValue(XString val)

Lends the value of 'defaultValue' to this object.

This method is equivalent to setDefaultValue except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The default value for the argument when not specified ... or not set if no default.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setDefaultValueFrom

void setDefaultValueFrom(long val)

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

Field Description

The default value for the argument when not specified ... or not set if no default.

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

getDefaultValueTo

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

Copies the value of this String field into a new XString from the given factory.

Field Description

The default value for the argument when not specified ... or not set if no default.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

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

setDefaultValueFrom

void setDefaultValueFrom(XString val)

Copies the provided XString value into this object's 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than setDefaultValue(String) because it avoids encoding the value into a String if the given XString is already encoded.

getDefaultValueTo

void getDefaultValueTo(XString val)

Copies the value of 'defaultValue' into the provided XString.

Field Description

The default value for the argument when not specified ... or not set if no default.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than getDefaultValue() bec because it can avoid decoding the value into an String.

See Also:

getDefaultValue()

getDefaultValueUnsafe

XString getDefaultValueUnsafe()

Gets the raw value of 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getDefaultValue()

clearDefaultValue

void clearDefaultValue()

Clears the value of 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

See Also:

setDefaultValue(String)

hasDefaultValue

boolean hasDefaultValue()

Checks for the presence of 'defaultValue'.

Field Description

The default value for the argument when not specified ... or not set if no default.

See Also:

getDefaultValue()

setValidValues

void setValidValues(String[] val)

Sets the value of 'validValues'.

Field Description

When set restricts the set of valid values for the command.

Parameters:

val - The value to set.

setValidValuesFrom

void setValidValuesFrom(XIterator<String> val)

Sets the value of 'validValues' using the values from the provided iterator.

This method will call XIterator.toFirst() before and after setting the values, meaning that all values from the iterator will be set and the iterator will be reset on return.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'validValues' accessor can copy the values without iteration.

Field Description

When set restricts the set of valid values for the command.

NOTE:
Passing a null or empty iterator has the same affect as calling setValidValues(String[]) with a value of null.

Parameters:

val - the values to set.

addValidValues

void addValidValues(String val)

Adds the provided value to the list of 'validValues' values.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that calling this with an iterator from another 'validValues' accessor can copy the values without iteration.

For objects generated with json encoding, or transactional state entities, using this method is currently efficient than doing a bulk set. For xbuf generated messages however, this method is optimized to directly serialize to an encoded backing buffer.

Field Description

When set restricts the set of valid values for the command.

Parameters:

val - the value to add.

getValidValuesIterator

XStringIterator getValidValuesIterator()

Gets the value of 'validValues' as iterator of values.

This method will always return a non null iterator value. The returned iterator is not threadsafe, and the caller may not hold on to it beyond the pooling lifespan of this object. Depending on the implementation, the same iterator instance may be returned by this object on each call to avoid garbage. Each time this method is called the iterator is reset by calling its toFirst() method. Callers should therefore be especially careful about calling this method while iterating on the iterator returned by this method.

This method is zero garbage for Xbuf generated classes, and this method is optimized such that passing the returned iterator to another object's setXXX(com.neeve.lang.XStringIterator) method can perform a direct copy of the underlying values without iteration.

Field Description

When set restricts the set of valid values for the command.

Returns:

An XStringIterator containing this field values.

getValidValues

String[] getValidValues()

Gets the value of 'validValues'.

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

Field Description

When set restricts the set of valid values for the command.

Returns:

When set restricts the set of valid values for the command. If the field is not set this method will return null.

getValidValuesEmptyIfNull

String[] getValidValuesEmptyIfNull()

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

Field Description

When set restricts the set of valid values for the command.

Returns:

When set restricts the set of valid values for the command. or an empty array if null if not set.

See Also:

getValidValues()

clearValidValues

void clearValidValues()

Clears the value of 'validValues'.

Field Description

When set restricts the set of valid values for the command.

See Also:

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

Lends the value of 'description' to this object.

This method is equivalent to setDescription except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The command description.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

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

setDisplayName

void setDisplayName(String val)

Sets the value of 'displayName'.

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

Parameters:

val - The value to set.

getDisplayName

String getDisplayName()

Gets the value of 'displayName'.

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

Returns:

The display name for the argument.

lendDisplayName

void lendDisplayName(XString val)

Lends the value of 'displayName' to this object.

This method is equivalent to setDisplayName except that it allows this object to defer copying the value until this object is next serialized. This means that the caller must not modify or dispose the value being passed in to this method.

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

Usage Notes

Note that implementations of this method are not strictly required to defer copying the value, this method only provides the hint to this object that it may defer copy. The caller must ensure that the value value is immutable and not disposed regardless.

Note, also, that unlike lendXXX methods for embedded entities, this method does not attempt to acquire or dispose of the value passed in even if the value is poolable.

Parameters:

val - The value to set.

Throws:

IllegalArgumentException - If the value is mutable.

setDisplayNameFrom

void setDisplayNameFrom(long val)

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

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

NOTE:
This is the same as calling 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 argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

If the value of this field is not null this method creates an XString from the provided Factory, copies this field's value into the type, and returns the new XString.);

This is a zero garbage operation if the provided factory is backed by a pool and the pool; has available instances;

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

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter can be more efficient than 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 argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter can be more efficient than 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 argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

NOTE:
This method retrieves the raw value backed by this object's buffer. This is a useful operation when copying this field value to another object because it avoids copying the data into an intermediate XString and instead allows direct byte transfer from the raw value to the target object.

However, this accessor is inherently unsafe because the buffer backing this object can be changed which would consequently invalidate the XString returned by this method. Consequently, the caller must not retain the returned raw value beyond the scope of this object's lifespan and access to the raw value follows the same threading rules as access to this object.

Additionally, the caller must not in any way mutate or modify the returned value as doing so could corrupt this object's backing buffer.

Returns:

the field's raw value

See Also:

getDisplayName()

clearDisplayName

void clearDisplayName()

Clears the value of 'displayName'.

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

See Also:

setDisplayName(String)

hasDisplayName

boolean hasDisplayName()

Checks for the presence of 'displayName'.

Field Description

The display name for the argument.

If a display name is not provided then the name should be used by tools. The display name is for display purposes only and cannot be used to invoke a command.

See Also:

getDisplayName()