LocalizationParam (vSphere Automation SDK for Java 7.0.1.0)

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

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class LocalizationParam
extends java.lang.Object
implements java.io.Serializable, 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 StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

LocalizationParam()
Default constructor.

protected LocalizationParam(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`LocalizationParam()` Default constructor.
`protected`	`LocalizationParam(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_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 if the runtime type name of this structure matches the type represented by the specified binding class.
`static LocalizationParam`	`_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.
`static LocalizationParam`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`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.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()` Returns a string representation of this structure.

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

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - LocalizationParam
```
public LocalizationParam()
```
    Default constructor.
  - LocalizationParam
```
protected LocalizationParam(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()
```
    Description copied from interface: StaticStructure
    
    WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
    
    Specified by:
    
    _getType in interface StaticStructure
    
    Returns:
    
    the static bindings StructType
  - _getDataValue
```
public StructValue _getDataValue()
```
    Description copied from interface: Structure
    
    Returns this 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.
    
    Specified by:
    
    _getDataValue in interface Structure
    
    Returns:
    
    StructValue representing this structure
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Description copied from interface: StaticStructure
    
    Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding 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:
  - all fields of the union required for that value of the discriminant are set
  - fields of the union that are not allowed for that value of the discriminant are not set
  - any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:: _validate in interface 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()
```
Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.
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.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
```
Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             DataValue fieldValue)
```
Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField
```
public DataValue _getDynamicField(java.lang.String fieldName)
```
Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_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()
```
Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static LocalizationParam _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.

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