Package javax.xml.registry.infomodel

Interface InternationalString

public interface InternationalString
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:

  • Method Details

    • getValue

      String getValue() throws JAXRException
      Gets the String value for the Locale returned by Locale.getDefault().
      Capability Level: 0
      Returns:
      the String value for the Locale returned by Locale.getDefault()
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • getValue

      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 - The Locale for the desired value
      Returns:
      the String value for the specified Locale
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • setValue

      void setValue(String value) throws JAXRException
      Sets the String value for the Locale returned by Locale.getDefault().
      Capability Level: 0
      Parameters:
      value - the String value for the Locale returned by Locale.getDefault()
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • setValue

      void setValue(Locale locale, String value) throws JAXRException
      Sets the String value for the specified Locale.
      Capability Level: 0
      Parameters:
      locale - The locale for this value being set
      value - The value being set
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • addLocalizedString

      void addLocalizedString(LocalizedString localizedString) throws JAXRException
      Adds a LocalizedString to this object.
      Capability Level: 0
      Parameters:
      localizedString - the LocalizedString being added to this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • addLocalizedStrings

      void addLocalizedStrings(Collection localizedStrings) throws JAXRException
      Adds many LocalizedStrings to this object.
      Capability Level: 0
      Parameters:
      localizedStrings - the Collection of LocalizedStrings being added to this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • removeLocalizedString

      void removeLocalizedString(LocalizedString localizedString) throws JAXRException
      Removes a LocalizedString from this object.
      Capability Level: 0
      Parameters:
      localizedString - the LocalizedString being removed from this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • removeLocalizedStrings

      void removeLocalizedStrings(Collection localizedStrings) throws JAXRException
      Removes specified LocalizedStrings to this object.
      Capability Level: 0
      Parameters:
      localizedStrings - the Collection of LocalizedStrings being removed from this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • getLocalizedString

      LocalizedString getLocalizedString(Locale locale, String charsetName) throws JAXRException
      Gets the LocalizedString for the specified Locale and charsetName.
      Capability Level: 0
      Parameters:
      locale - The loacle for the desired LocalizedStrings
      charsetName - The character set name for the desired LocalizedStrings
      Returns:
      the LocalizedString that matches specified locale and character set
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error

    • getLocalizedStrings

      Collection getLocalizedStrings() throws JAXRException
      Returns the LocalizedStrings associated with this object.
      Capability Level: 0
      Returns:
      Collection of LocalizedString instances. The Collection may be empty but not null.
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
      See Also: