Interface LocalizedString


public interface LocalizedString
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:
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    The default name returned by getCharsetName if no other name has explicitly been set.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the canonical name for the charset for this object.
    Get the Locale for this object.
    Get the String value for this object.
    void
    setCharsetName(String charsetName)
    Set the canonical name for the charset for this object.
    void
    setLocale(Locale locale)
    Set the Locale for this object.
    void
    Set the String value for the specified object.
  • Field Details

    • DEFAULT_CHARSET_NAME

      static final String DEFAULT_CHARSET_NAME
      The default name returned by getCharsetName if no other name has explicitly been set.
      See Also:
  • Method Details

    • getCharsetName

      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:
      the character set name for the character set used by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
      See Also:
    • getLocale

      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:
      the Locale used by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
      See Also:
    • getValue

      String getValue() throws JAXRException
      Get the String value for this object.
      Capability Level: 0
      Returns:
      the value defined by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
    • setCharsetName

      void setCharsetName(String charsetName) throws JAXRException
      Set the canonical name for the charset for this object.
      Capability Level: 0
      Parameters:
      charsetName - the character set name for the character set used by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
    • setLocale

      void setLocale(Locale locale) throws JAXRException
      Set the Locale for this object.
      Capability Level: 0
      Parameters:
      locale - the Locale used by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error
    • setValue

      void setValue(String value) throws JAXRException
      Set the String value for the specified object.
      Capability Level: 0
      Parameters:
      value - the value defined by this object
      Throws:
      JAXRException - If the Jakarta XML Registries provider encounters an internal error