Top Description Methods
javax.xml.registry.infomodel

public Interface InternationalString

Imports
javax.xml.registry.*, java.util.*
This interface represents a String that has been internationalized into several Locales. This interface is used as a replacement for the String type whenever a String attribute needs to be I18N capable. An instance of the InternationalString interface composes within it a Collection of LocalizedString instances, where each String is specific to a particular Locale. The InternationalString interface provides set/get methods for adding or getting locale specific String values for the InternationalString instance.
Author
Farrukh S. Najmi
See Also
LocalizedString

Method Summary

Modifier and TypeMethod and Description
public void
addLocalizedString(LocalizedString
the LocalizedString being added to this object
localizedString)

Adds a LocalizedString to this object.

public void
addLocalizedStrings(Collection<E>
the Collection of LocalizedStrings being added to this object
localizedStrings)

Adds many LocalizedStrings to this object.

public LocalizedString

Returns:

the LocalizedString that matches specified locale and character set
getLocalizedString(Locale
The loacle for the desired LocalizedStrings
locale, String
The character set name for the desired LocalizedStrings
charsetName)

Gets the LocalizedString for the specified Locale and charsetName.

public Collection<E>

Returns:

Collection of LocalizedString instances. The Collection may be empty but not null.
getLocalizedStrings()

Returns the LocalizedStrings associated with this object.

public String

Returns:

the String value for the Locale returned by Locale.getDefault()
getValue()

Gets the String value for the Locale returned by Locale.getDefault().

public String

Returns:

the String value for the specified Locale
getValue(Locale
The Locale for the desired value
locale)

Gets the String value for the specified Locale.

public void
removeLocalizedString(LocalizedString
the LocalizedString being removed from this object
localizedString)

Removes a LocalizedString from this object.

public void
removeLocalizedStrings(Collection<E>
the Collection of LocalizedStrings being removed from this object
localizedStrings)

Removes specified LocalizedStrings to this object.

public void
setValue(String
the String value for the Locale returned by Locale.getDefault()
value)

Sets the String value for the Locale returned by Locale.getDefault().

public void
setValue(Locale
The locale for this value being set
locale, String
The value being set
value)

Sets the String value for the specified Locale.

Method Detail

addLocalizedStringback to summary
public void addLocalizedString(LocalizedString localizedString) throws JAXRException

Adds a LocalizedString to this object.

Capability Level: 0
Parameters
localizedString:LocalizedString

the LocalizedString being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addLocalizedStringsback to summary
public void addLocalizedStrings(Collection<E> localizedStrings) throws JAXRException

Adds many LocalizedStrings to this object.

Capability Level: 0
Parameters
localizedStrings:Collection<E>

the Collection of LocalizedStrings being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getLocalizedStringback to summary
public LocalizedString getLocalizedString(Locale locale, String charsetName) throws JAXRException

Gets the LocalizedString for the specified Locale and charsetName.

Capability Level: 0
Parameters
locale:Locale

The loacle for the desired LocalizedStrings

charsetName:String

The character set name for the desired LocalizedStrings

Returns:LocalizedString

the LocalizedString that matches specified locale and character set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getLocalizedStringsback to summary
public Collection<E> getLocalizedStrings() throws JAXRException

Returns the LocalizedStrings associated with this object.

Capability Level: 0
Returns:Collection<E>

Collection of LocalizedString instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.LocalizedString
getValueback to summary
public String getValue() throws JAXRException

Gets the String value for the Locale returned by Locale.getDefault().

Capability Level: 0
Returns:String

the String value for the Locale returned by Locale.getDefault()

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getValueback to summary
public String getValue(Locale locale) throws JAXRException

Gets the String value for the specified Locale. Return null if no locale specific value is found for the specified locale.

Capability Level: 0
Parameters
locale:Locale

The Locale for the desired value

Returns:String

the String value for the specified Locale

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeLocalizedStringback to summary
public void removeLocalizedString(LocalizedString localizedString) throws JAXRException

Removes a LocalizedString from this object.

Capability Level: 0
Parameters
localizedString:LocalizedString

the LocalizedString being removed from this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeLocalizedStringsback to summary
public void removeLocalizedStrings(Collection<E> localizedStrings) throws JAXRException

Removes specified LocalizedStrings to this object.

Capability Level: 0
Parameters
localizedStrings:Collection<E>

the Collection of LocalizedStrings being removed from this object

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

Sets the String value for the Locale returned by Locale.getDefault().

Capability Level: 0
Parameters
value:String

the String value for the Locale returned by Locale.getDefault()

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

Sets the String value for the specified Locale.

Capability Level: 0
Parameters
locale:Locale

The locale for this value being set

value:String

The value being set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error