|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
@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 ISrvMonOptionDescriptionDescripes a command option
| Method Summary | ||
|---|---|---|
void |
addValidValues(String val)
Adds the provided value to the list of 'validValues' values. |
|
void |
clearDefaultValue()
Clears the value of 'defaultValue' Field Description The default value for an option when not specified ... or not set if no default |
|
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 argument If a display name is not provided then the name should be used by tools. |
|
void |
clearLongForm()
Clears the value of 'longForm' Field Description The long form of the command. e.g. |
|
void |
clearRequired()
Clears the value of 'required' Field Description Whether or not the option is required |
|
void |
clearShortForm()
Clears the value of 'shortForm' Field Description The short form of the command. e.g. |
|
void |
clearType()
Clears the value of 'type' Field Description Describes the type of the argument |
|
void |
clearValidValues()
Clears the value of 'validValues' Field Description When set restricts the set of valid values for the command |
|
String |
getDefaultValue()
Gets the value of 'defaultValue' Field Description The default value for an option when not specified ... or not set if no default |
|
|
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' Field Description The command description |
|
|
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 argument If a display name is not provided then the name should be used by tools. |
|
|
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 |
getLongForm()
Gets the value of 'longForm' Field Description The long form of the command. e.g. |
|
|
getLongFormTo(XString.Factory<T> factory)
Copies the value of this String field into a new XString from the given factory. |
|
void |
getLongFormTo(XString val)
Copies the value of 'longForm' into the provided XString. |
|
XString |
getLongFormUnsafe()
Gets the raw value of 'longForm'. |
|
boolean |
getRequired()
Gets the value of 'required' Field Description Whether or not the option is required |
|
char |
getShortForm()
Gets the value of 'shortForm' Field Description The short form of the command. e.g. |
|
SrvMonOptionType |
getType()
Gets the value of 'type' Field Description Describes the type of the argument |
|
String[] |
getValidValues()
Gets the value of 'validValues' If the field is not set this method will return null. |
|
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' Field Description The default value for an option when not specified ... or not set if no default |
|
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 argument If a display name is not provided then the name should be used by tools. |
|
boolean |
hasLongForm()
Checks for the presence of 'longForm' Field Description The long form of the command. e.g. |
|
boolean |
hasRequired()
Checks for the presence of 'required' Field Description Whether or not the option is required |
|
boolean |
hasShortForm()
Checks for the presence of 'shortForm' Field Description The short form of the command. e.g. |
|
boolean |
hasType()
Checks for the presence of 'type' Field Description Describes the type of the argument |
|
void |
lendDefaultValue(XString val)
Sets the value of 'defaultValue' Field Description The default value for an option when not specified ... or not set if no default |
|
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 argument If a display name is not provided then the name should be used by tools. |
|
void |
lendLongForm(XString val)
Sets the value of 'longForm' Field Description The long form of the command. e.g. |
|
void |
setDefaultValue(String val)
Sets the value of 'defaultValue' Field Description The default value for an option when not specified ... or not set if no default |
|
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' 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 argument If a display name is not provided then the name should be used by tools. |
|
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 |
setLongForm(String val)
Sets the value of 'longForm' Field Description The long form of the command. e.g. |
|
void |
setLongFormFrom(long val)
Sets the value of this String field to the given numeric value. |
|
void |
setLongFormFrom(XString val)
Copies the provided XString value into this object's 'longForm'. |
|
void |
setRequired(boolean val)
Sets the value of 'required' Field Description Whether or not the option is required |
|
void |
setShortForm(char val)
Sets the value of 'shortForm' Field Description The short form of the command. e.g. |
|
void |
setType(SrvMonOptionType val)
Sets the value of 'type' Field Description Describes the type of the argument |
|
void |
setValidValues(String[] val)
Sets the value of 'validValues' Field Description When set restricts the set of valid values for the command |
|
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 |
|---|
void setShortForm(char val)
val - The value to set.char getShortForm()
void clearShortForm()
setShortForm(char)boolean hasShortForm()
getShortForm()void setRequired(boolean val)
val - The value to set.boolean getRequired()
void clearRequired()
setRequired(boolean)boolean hasRequired()
getRequired()void setType(SrvMonOptionType val)
val - The value to set.SrvMonOptionType getType()
void clearType()
setType(SrvMonOptionType)boolean hasType()
getType()void setLongForm(String val)
val - The value to set.String getLongForm()
void lendLongForm(XString val)
val - The value to set.void setLongFormFrom(long val)
NOTE:
This is the same as calling setLongForm(String).
with Long.valueOf(val).toString(), except that using this method is a zero garbage
operation for Xbuf encoding.
<T extends XString> T getLongFormTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setLongFormFrom(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this setter
can be more efficient than setLongForm(String)
because it avoids encoding the value into a String if the given XString is already encoded.
void getLongFormTo(XString val)
NOTE:
This is a Zero Garbage operation for XBuf encoded objects. Additionally, this getter
can be more efficient than getLongForm() bec
because it can avoid decoding the value into an String.
getLongForm()XString getLongFormUnsafe()
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.
getLongForm()void clearLongForm()
setLongForm(String)boolean hasLongForm()
getLongForm()void setDefaultValue(String val)
val - The value to set.String getDefaultValue()
void lendDefaultValue(XString val)
val - The value to set.void setDefaultValueFrom(long val)
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.
<T extends XString> T getDefaultValueTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setDefaultValueFrom(XString val)
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.
void getDefaultValueTo(XString val)
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.
getDefaultValue()XString getDefaultValueUnsafe()
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.
getDefaultValue()void clearDefaultValue()
setDefaultValue(String)boolean hasDefaultValue()
getDefaultValue()void setValidValues(String[] val)
val - The value to set.void setValidValuesFrom(XIterator<String> val)
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.
NOTE:
Passing a null or empty iterator has the same affect as calling setValidValues(String[]) with
a value of null.
val - the values to set.void addValidValues(String val)
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.
val - the value to add.XStringIterator getValidValuesIterator()
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.
String[] getValidValues()
If the field is not set this method will return null.
null.String[] getValidValuesEmptyIfNull()
null or not set.
null if not set.getValidValues()void clearValidValues()
setValidValues(String[])void setDescription(String val)
val - The value to set.String getDescription()
void lendDescription(XString val)
val - The value to set.void setDescriptionFrom(long val)
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.
<T extends XString> T getDescriptionTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setDescriptionFrom(XString val)
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.
void getDescriptionTo(XString val)
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.
getDescription()XString getDescriptionUnsafe()
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.
getDescription()void clearDescription()
setDescription(String)boolean hasDescription()
getDescription()void setDisplayName(String val)
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.
val - The value to set.String getDisplayName()
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.
void lendDisplayName(XString val)
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.
val - The value to set.void setDisplayNameFrom(long val)
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.
<T extends XString> T getDisplayNameTo(XString.Factory<T> factory)
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;
factory - The factory from which to get the XString to copy into and return
null.
NullPointerException - if the provided factory is nullvoid setDisplayNameFrom(XString val)
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.
void getDisplayNameTo(XString val)
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.
getDisplayName()XString getDisplayNameUnsafe()
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.
getDisplayName()void clearDisplayName()
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.
setDisplayName(String)boolean hasDisplayName()
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.
getDisplayName()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||