Top Description Fields Methods
javax.xml.registry.infomodel

public Interface LocalizedString

Imports
javax.xml.registry.*, java.util.*
This interface is used as a simple wrapper interface that associates a String with its Locale. The interface is needed in the InternationalString interface where a Collection of LocalizedString instances are kept. Each LocalizedString instance has a Locale and a String instance.
Author
Farrukh S. Najmi
See Also
InternationalString

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT_CHARSET_NAME

The default name returned by getCharsetName if no other name has explicitly been set.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the character set name for the character set used by this object
getCharsetName()

Gets the canonical name for the charset for this object.

public Locale

Returns:

the Locale used by this object
getLocale()

Get the Locale for this object.

public String

Returns:

the value defined by this object
getValue()

Get the String value for this object.

public void
setCharsetName(String
the character set name for the character set used by this object
charsetName)

Set the canonical name for the charset for this object.

public void
setLocale(Locale
the Locale used by this object
locale)

Set the Locale for this object.

public void
setValue(String
the value defined by this object
value)

Set the String value for the specified object.

Field Detail

DEFAULT_CHARSET_NAMEback to summary
public static final String DEFAULT_CHARSET_NAME

The default name returned by getCharsetName if no other name has explicitly been set.

Method Detail

getCharsetNameback to summary
public String getCharsetName() throws JAXRException

Gets the canonical name for the charset for this object. Must return the default charset when there is no charset name defined.

Capability Level: 0
Returns:String

the character set name for the character set used by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
LocalizedString#DEFAULT_CHARSET_NAME
getLocaleback to summary
public Locale getLocale() throws JAXRException

Get the Locale for this object. Must return the default Locale when no Locale has been defined.

Capability Level: 0
Returns:Locale

the Locale used by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
java.util.Locale#getDefault()
getValueback to summary
public String getValue() throws JAXRException

Get the String value for this object.

Capability Level: 0
Returns:String

the value defined by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setCharsetNameback to summary
public void setCharsetName(String charsetName) throws JAXRException

Set the canonical name for the charset for this object.

Capability Level: 0
Parameters
charsetName:String

the character set name for the character set used by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setLocaleback to summary
public void setLocale(Locale locale) throws JAXRException

Set the Locale for this object.

Capability Level: 0
Parameters
locale:Locale

the Locale used by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setValueback to summary
public void setValue(String value) throws JAXRException

Set the String value for the specified object.

Capability Level: 0
Parameters
value:String

the value defined by this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error