LocalizationParam

java.lang.Object
- com.vmware.vapi.std.LocalizationParam

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class LocalizationParam
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This class holds a single message parameter and formatting settings for it. The class has fields for String, long, double, date time and nested messages. Only one will be used depending on the type of data sent. For date, double and long it is possible to set additional formatting details. This class was added in vSphere API 7.0.0.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalizationParam.Builder` Builder class for `LocalizationParam`.
`static class`	`LocalizationParam.DateTimeFormat` The `DateTimeFormat` enumeration class lists possible date and time formatting options.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

LocalizationParam()
Default constructor.

protected LocalizationParam(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`LocalizationParam()` Default constructor.
`protected`	`LocalizationParam(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`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.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static LocalizationParam`	`_newInstance(com.vmware.vapi.data.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.
`static LocalizationParam`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Double`	`getD()` The `double` value associated with the parameter.
`java.util.Calendar`	`getDt()` Date and time value associated with the parameter.
`LocalizationParam.DateTimeFormat`	`getFormat()` Format associated with the date and time value in `getDt()` property.
`java.lang.Long`	`getI()` `long` value associated with the parameter.
`NestedLocalizableMessage`	`getL()` Nested localizable value associated with the parameter.
`java.lang.Long`	`getPrecision()` Number of fractional digits to include in formatted `double` value.
`java.lang.String`	`getS()` `String` value associated with the parameter.
`int`	`hashCode()`
`void`	`setD(java.lang.Double d)` The `double` value associated with the parameter.
`void`	`setDt(java.util.Calendar dt)` Date and time value associated with the parameter.
`void`	`setFormat(LocalizationParam.DateTimeFormat format)` Format associated with the date and time value in `getDt()` property.
`void`	`setI(java.lang.Long i)` `long` value associated with the parameter.
`void`	`setL(NestedLocalizableMessage l)` Nested localizable value associated with the parameter.
`void`	`setPrecision(java.lang.Long precision)` Number of fractional digits to include in formatted `double` value.
`void`	`setS(java.lang.String s)` `String` value associated with the parameter.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - LocalizationParam
```
public LocalizationParam()
```
    Default constructor.
  - LocalizationParam
```
protected LocalizationParam(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getS
```
public java.lang.String getS()
```
    String value associated with the parameter. This property was added in vSphere API 7.0.0.0. this property will be set when String value is used.
    
    Returns:
    
    The current value of the property.
  - setS
```
public void setS(java.lang.String s)
```
    String value associated with the parameter. This property was added in vSphere API 7.0.0.0. this property will be set when String value is used.
    
    Parameters:
    
    s - New value for the property.
  - getDt
```
public java.util.Calendar getDt()
```
    Date and time value associated with the parameter. Use the getFormat() property to specify date and time display style. This property was added in vSphere API 7.0.0.0. this property will be set when date and time value is used.
    
    Returns:
    
    The current value of the property.
  - setDt
```
public void setDt(java.util.Calendar dt)
```
    Date and time value associated with the parameter. Use the getFormat() property to specify date and time display style. This property was added in vSphere API 7.0.0.0. this property will be set when date and time value is used.
    
    Parameters:
    
    dt - New value for the property.
  - getI
```
public java.lang.Long getI()
```
    long value associated with the parameter. This property was added in vSphere API 7.0.0.0. this property will be set when long value is used.
    
    Returns:
    
    The current value of the property.
  - setI
```
public void setI(java.lang.Long i)
```
    long value associated with the parameter. This property was added in vSphere API 7.0.0.0. this property will be set when long value is used.
    
    Parameters:
    
    i - New value for the property.
  - getD
```
public java.lang.Double getD()
```
    The double value associated with the parameter. The number of displayed fractional digits is changed via getPrecision() property. This property was added in vSphere API 7.0.0.0. this property will be set when double value is used.
    
    Returns:
    
    The current value of the property.
  - setD
```
public void setD(java.lang.Double d)
```
    The double value associated with the parameter. The number of displayed fractional digits is changed via getPrecision() property. This property was added in vSphere API 7.0.0.0. this property will be set when double value is used.
    
    Parameters:
    
    d - New value for the property.
  - getL
```
public NestedLocalizableMessage getL()
```
    Nested localizable value associated with the parameter. This is useful construct to convert to human readable localized form enumeration class and boolean values. It can also be used for proper handling of pluralization and gender forms in localization. Recursive NestedLocalizableMessage instances can be used for localizing short lists of items. This property was added in vSphere API 7.0.0.0. this property will be set when nested localization message value is used.
    
    Returns:
    
    The current value of the property.
  - setL
```
public void setL(NestedLocalizableMessage l)
```
    Nested localizable value associated with the parameter. This is useful construct to convert to human readable localized form enumeration class and boolean values. It can also be used for proper handling of pluralization and gender forms in localization. Recursive NestedLocalizableMessage instances can be used for localizing short lists of items. This property was added in vSphere API 7.0.0.0. this property will be set when nested localization message value is used.
    
    Parameters:
    
    l - New value for the property.
  - getFormat
```
public LocalizationParam.DateTimeFormat getFormat()
```
    Format associated with the date and time value in getDt() property. The enumeration constant SHORT_DATETIME will be used as default. This property was added in vSphere API 7.0.0.0. this may not be set if enumeration constant SHORT_DATETIME default format is appropriate
    
    Returns:
    
    The current value of the property.
  - setFormat
```
public void setFormat(LocalizationParam.DateTimeFormat format)
```
    Format associated with the date and time value in getDt() property. The enumeration constant SHORT_DATETIME will be used as default. This property was added in vSphere API 7.0.0.0. this may not be set if enumeration constant SHORT_DATETIME default format is appropriate
    
    Parameters:
    
    format - New value for the property.
  - getPrecision
```
public java.lang.Long getPrecision()
```
    Number of fractional digits to include in formatted double value. This property was added in vSphere API 7.0.0.0. this will be set when exact precision is required for rendering double numbers.
    
    Returns:
    
    The current value of the property.
  - setPrecision
```
public void setPrecision(java.lang.Long precision)
```
    Number of fractional digits to include in formatted double value. This property was added in vSphere API 7.0.0.0. this will be set when exact precision is required for rendering double numbers.
    
    Parameters:
    
    precision - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static LocalizationParam _newInstance(com.vmware.vapi.data.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.
    
    Parameters:
    
    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.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static LocalizationParam _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class LocalizationParam

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

LocalizationParam

LocalizationParam

Method Detail

getS

setS

getDt

setDt

getI

setI

getD

setD

getL

setL

getFormat

setFormat

getPrecision

setPrecision

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2