LocalizableMessage (VMware-vmc-SDK-Java)

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

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable
```
public final class LocalizableMessage
extends java.lang.Object
implements java.io.Serializable, StaticStructure
```
The LocalizableMessage class represents localizable string and message template. Interfaces include one or more localizable message templates in the exceptions they report so that clients can display diagnostic messages in the native language of the user. Interfaces can include localizable strings in the data returned from methods to allow clients to display localized status information in the native language of the user.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class LocalizableMessage.Builder
Builder class for LocalizableMessage.

Nested Classes
Modifier and Type	Class and Description
`static class`	`LocalizableMessage.Builder` Builder class for `LocalizableMessage`.

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
	`LocalizableMessage()` Default constructor.
	`LocalizableMessage(java.lang.String id, java.lang.String defaultMessage, java.util.List<java.lang.String> args)` This constructor is provided for backwards compatibility purposes only.
`protected`	`LocalizableMessage(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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).
`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 LocalizableMessage`	`_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 LocalizableMessage`	`_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.util.List<java.lang.String>`	`getArgs()` Positional arguments to be substituted into the message template.
`java.lang.String`	`getDefaultMessage()` The value of this localizable string or message template in the `en_US` (English) locale.
`java.lang.String`	`getId()` Unique identifier of the localizable string or message template.
`java.lang.String`	`getLocalized()` Localized string value as per request requirements.
`java.util.Map<java.lang.String,LocalizationParam>`	`getParams()` Named arguments to be substituted into the message template.
`int`	`hashCode()`
`void`	`setArgs(java.util.List<java.lang.String> args)` Positional arguments to be substituted into the message template.
`void`	`setDefaultMessage(java.lang.String defaultMessage)` The value of this localizable string or message template in the `en_US` (English) locale.
`void`	`setId(java.lang.String id)` Unique identifier of the localizable string or message template.
`void`	`setLocalized(java.lang.String localized)` Localized string value as per request requirements.
`void`	`setParams(java.util.Map<java.lang.String,LocalizationParam> params)` Named arguments to be substituted into the message template.
`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
  - LocalizableMessage
```
public LocalizableMessage(java.lang.String id,
                          java.lang.String defaultMessage,
                          java.util.List<java.lang.String> args)
```
    This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.
  - LocalizableMessage
```
public LocalizableMessage()
```
    Default constructor.
  - LocalizableMessage
```
protected LocalizableMessage(StructValue __dynamicStructureFields)
```
- Method Detail
  - getId
```
public java.lang.String getId()
```
    Unique identifier of the localizable string or message template.
    This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of the localizable string or message template.
    This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
    
    Parameters:
    
    id - New value for the property.
  - getDefaultMessage
```
public java.lang.String getDefaultMessage()
```
    The value of this localizable string or message template in the en_US (English) locale. If getId() refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
    
    Returns:
    
    The current value of the property.
  - setDefaultMessage
```
public void setDefaultMessage(java.lang.String defaultMessage)
```
    The value of this localizable string or message template in the en_US (English) locale. If getId() refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
    
    Parameters:
    
    defaultMessage - New value for the property.
  - getArgs
```
public java.util.List<java.lang.String> getArgs()
```
    Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
    
    Returns:
    
    The current value of the property.
  - setArgs
```
public void setArgs(java.util.List<java.lang.String> args)
```
    Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
    
    Parameters:
    
    args - New value for the property.
  - getParams
```
public java.util.Map<java.lang.String,LocalizationParam> getParams()
```
    Named arguments to be substituted into the message template. null means that the message template requires no arguments or positional arguments are used.
    
    Returns:
    
    The current value of the property.
  - setParams
```
public void setParams(java.util.Map<java.lang.String,LocalizationParam> params)
```
    Named arguments to be substituted into the message template. null means that the message template requires no arguments or positional arguments are used.
    
    Parameters:
    
    params - New value for the property.
  - getLocalized
```
public java.lang.String getLocalized()
```
    Localized string value as per request requirements. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
    
    Returns:
    
    The current value of the property.
  - setLocalized
```
public void setLocalized(java.lang.String localized)
```
    Localized string value as per request requirements. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
    
    Parameters:
    
    localized - 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 structure definition, i.e. not represented with getter/setter.

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 a dynamic field value, doesn't allow access to static fields (which have getters/setters).

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 LocalizableMessage _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 LocalizableMessage _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class LocalizableMessage

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

LocalizableMessage

LocalizableMessage

LocalizableMessage

Method Detail

getId

setId

getDefaultMessage

setDefaultMessage

getArgs

setArgs

getParams

setParams

getLocalized

setLocalized

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2