com.vmware.vapi.std

Class LocalizableMessage

java.lang.Object

com.vmware.vapi.std.LocalizableMessage

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class LocalizableMessage
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.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.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.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(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Method Summary

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 LocalizableMessage	_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 LocalizableMessage	_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.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()

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

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(com.vmware.vapi.data.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. This property was added in vSphere API 7.0.0.0. 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. This property was added in vSphere API 7.0.0.0. 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. This property was added in vSphere API 7.0.0.0. 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. This property was added in vSphere API 7.0.0.0. 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()

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 LocalizableMessage _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 LocalizableMessage _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.