Package org.opencms.xml

Class CmsXmlMessages

java.lang.Object
org.opencms.i18n.CmsMessages
org.opencms.xml.CmsXmlMessages
public class CmsXmlMessages extends CmsMessages
The xml messages overwrite some methods of the general CmsMessages class to get keys from an individual configuration file.

As fallback if no file was specified or no value was found for the desired key, a common CmsMessages object is used to get the localized value.

Since:
6.5.4

  • Constructor Details

    • CmsXmlMessages

      public CmsXmlMessages(CmsMessages messages, String configurationFileName, String pathPrefix, Locale locale)
      Constructor, with parameters.

      Creates the necessary member objects using the passed arguments.

      Parameters:
      messages - the messages object to use as fallback
      configurationFileName - the absolute path (including site root!) to the configuration file containing localized keys
      pathPrefix - the (optional) xPath prefix to the element nodes
      locale - the locale to use for localization

    • CmsXmlMessages

      public CmsXmlMessages(String bundleName, String configurationFileName, String pathPrefix, Locale locale)
      Constructor, with parameters.

      Creates the necessary member objects using the passed arguments.

      Parameters:
      bundleName - the name of the ResourceBundle to use
      configurationFileName - the absolute path (including site root!) to the configuration file containing localized keys
      pathPrefix - the (optional) xPath prefix to the element nodes
      locale - the locale to use for localization

  • Method Details

    • getMessages

      public CmsMessages getMessages()
      Returns the messages.

      Returns:
      the messages

    • key

      public String key(String keyName)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      key in class CmsMessages
      Parameters:
      keyName - the key for the desired string
      Returns:
      the resource string for the given key
      See Also:

    • key

      public String key(String key, Object arg0)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      key in class CmsMessages
      Parameters:
      key - the message key
      arg0 - the message argument
      Returns:
      the selected localized message for the initialized resource bundle and locale
      See Also:

    • key

      public String key(String key, Object arg0, Object arg1)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      key in class CmsMessages
      Parameters:
      key - the message key
      arg0 - the first message argument
      arg1 - the second message argument
      Returns:
      the selected localized message for the initialized resource bundle and locale
      See Also:

    • key

      public String key(String key, Object arg0, Object arg1, Object arg2)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      key in class CmsMessages
      Parameters:
      key - the message key
      arg0 - the first message argument
      arg1 - the second message argument
      arg2 - the third message argument
      Returns:
      the selected localized message for the initialized resource bundle and locale
      See Also:

    • key

      public String key(String key, Object[] args)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      key in class CmsMessages
      Parameters:
      key - the message key
      args - the message arguments
      Returns:
      the selected localized message for the initialized resource bundle and locale
      See Also:

    • keyDefault

      public String keyDefault(String keyName, String defaultValue)
      Returns the localized resource String from the configuration file, if not found or set from the resource bundle.

      Overrides:
      keyDefault in class CmsMessages
      Parameters:
      keyName - the key for the desired string
      defaultValue - the default value in case the key does not exist in the bundle
      Returns:
      the resource string for the given key it it exists, or the given default if not
      See Also:

    • setMessages

      public void setMessages(CmsMessages messages)
      Sets the messages.

      Parameters:
      messages - the messages

    • getConfigValue

      protected String getConfigValue(String key)
      Returns the value for the given key from the configuration file.

      Parameters:
      key - the key to get the value for
      Returns:
      the value for the given key

    • getConfigValue

      protected String getConfigValue(String key, Object[] args)
      Returns the substituted value for the given key and arguments from the configuration file.

      Parameters:
      key - the key to get the value for
      args - the arguments that should be substituted
      Returns:
      the substituted value for the given key and arguments

    • hasConfigValue

      protected boolean hasConfigValue(String key)
      Checks if the given key is provided in the configuration file.

      Parameters:
      key - the key to check
      Returns:
      true if the given key is provided in the configuration file, otherwise false

    • initLocalizationContent

      protected void initLocalizationContent(String configurationFileName)
      Initializes the content used for localizing the output.

      Parameters:
      configurationFileName - the absolute path including site root to the configuration file containing localized keys

    • initPathPrefix

      protected void initPathPrefix(String pathPrefix)
      Initializes the (optional) xPath prefix to the element nodes.

      Parameters:
      pathPrefix - the (optional) xPath prefix to the element nodes