Package com.adobe.epubcheck.messages

Class LocalizedMessages

  • public class LocalizedMessages
extends java.lang.Object
    Manages storage, caching and retrieval of default localized messages.

    • Field Detail

      • locale

        private final java.util.Locale locale

      • bundle

        private final java.util.ResourceBundle bundle

      • localizedMessages

        private static final java.util.Map<java.lang.String,​LocalizedMessages> localizedMessages

      • cachedMessages

        private final java.util.Map<MessageId,​Message> cachedMessages

      • defaultSeverities

        private final Severities defaultSeverities

    • Constructor Detail

      • LocalizedMessages

        public LocalizedMessages​(java.util.Locale locale)
        Typical pattern for instantiation should use the static getInstance() methods to ensure that cached objects are used. If that behavior isn't desired, direct instantiation is also an option using this constructor.
        Parameters:
        locale - The locale used to localize the messages, or default.

    • Method Detail

      • getInstance

        public static LocalizedMessages getInstance()
        Provides messages for the default locale.
        Returns:
        Localized messages.

      • getInstance

        public static LocalizedMessages getInstance​(java.util.Locale locale)
        Provides messages for the given locale.
        Parameters:
        locale - The locale. If null or unsupported, will use the default locale instead.
        Returns:
        Localized messages.

      • getMessage

        public Message getMessage​(MessageId id)
        Gets the message for the given id.
        Parameters:
        id -
        Returns:
        A Message object, using the localized string if necessary.

      • getStringFromBundle

        private java.lang.String getStringFromBundle​(java.lang.String id)

      • getMessageAsString

        private java.lang.String getMessageAsString​(MessageId id)

      • getSuggestion

        public java.lang.String getSuggestion​(MessageId id)
        Returns the suggestion message for the given message ID. In other words, for a message ID of `XXX_NNN`, returns the bundle message named `XXX_NNN_SUG`.
        Parameters:
        id - a message ID
        Returns:
        the associated suggestion, or the empty string if there's none.

      • getSuggestion

        public java.lang.String getSuggestion​(MessageId id,
                                      java.lang.String key)
        Returns the suggestion message for the given message ID and key. In other words, for a message ID of `XXX_NNN`, and a key `key`, returns the bundle message named `XXX_NNN_SUG.key`. If the suggestion key is not found, returns the bundle message named `XXX_NNN_SUG.default`. If this latter is not found, returns the bundle message nameed `XXX_NNN_SUG`.
        Parameters:
        id - a message ID
        key - the key of a specific suggestion string
        Returns:
        the associated suggestion string