public static final class CommandTypes.OptionInfo extends java.lang.Object implements java.io.Serializable, StaticStructure
OptionInfo
class describes information about a specific input option
of a command.Modifier and Type | Class and Description |
---|---|
static class |
CommandTypes.OptionInfo.Builder
Builder class for
CommandTypes.OptionInfo . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
CommandTypes.OptionInfo()
Default constructor.
|
protected |
CommandTypes.OptionInfo(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get dynamic filed value.
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks that the runtime type name matches the type name from the binding
class.
|
static CommandTypes.OptionInfo |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDescription()
The description of the option to be displayed to the user when they request
usage information for a CLI command.
|
java.lang.String |
getFieldName()
The fully qualified name of the option referred to by the operation element in
CommandTypes.Info.getOperationId() . |
CommandTypes.GenericType |
getGeneric()
This is used to tell the user whether the option is required or optional, or
whether they can specify the option multiple times.
|
java.lang.String |
getLongOption()
The long option name of the parameter as used by the user.
|
java.lang.String |
getShortOption()
The single character value option name.
|
java.lang.String |
getType()
The type of option.
|
int |
hashCode() |
void |
setDescription(java.lang.String description)
The description of the option to be displayed to the user when they request
usage information for a CLI command.
|
void |
setFieldName(java.lang.String fieldName)
The fully qualified name of the option referred to by the operation element in
CommandTypes.Info.getOperationId() . |
void |
setGeneric(CommandTypes.GenericType generic)
This is used to tell the user whether the option is required or optional, or
whether they can specify the option multiple times.
|
void |
setLongOption(java.lang.String longOption)
The long option name of the parameter as used by the user.
|
void |
setShortOption(java.lang.String shortOption)
The single character value option name.
|
void |
setType(java.lang.String type)
The type of option.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected final StructValue __dynamicStructureFields
public CommandTypes.OptionInfo()
protected CommandTypes.OptionInfo(StructValue __dynamicStructureFields)
public java.lang.String getLongOption()
public void setLongOption(java.lang.String longOption)
longOption
- New value for the property.public java.lang.String getShortOption()
public void setShortOption(java.lang.String shortOption)
shortOption
- New value for the property.public java.lang.String getFieldName()
CommandTypes.Info.getOperationId()
.public void setFieldName(java.lang.String fieldName)
CommandTypes.Info.getOperationId()
.fieldName
- New value for the property.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- New value for the property.public java.lang.String getType()
public void setType(java.lang.String type)
type
- New value for the property.public CommandTypes.GenericType getGeneric()
public void setGeneric(CommandTypes.GenericType generic)
generic
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot be null.public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static CommandTypes.OptionInfo _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType