Package com.google.javascript.jscomp

Class JsMessage.Builder

  • Enclosing class:
    JsMessage
    @GwtIncompatible("java.util.regex")
public static final class JsMessage.Builder
extends java.lang.Object
    Contains functionality for creating JS messages. Generates authoritative keys and fingerprints for a message that must stay constant over time.

    This implementation correctly processes unnamed messages and creates a key for them that looks like MSG_<fingerprint value>;.

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Gets the message's key (e.g. "MSG_HELLO").

      • setKey

        @CanIgnoreReturnValue
public JsMessage.Builder setKey​(java.lang.String key)
        Parameters:
        key - a key that should uniquely identify this message; typically it is the message's name (e.g. "MSG_HELLO").

      • setSourceName

        @CanIgnoreReturnValue
public JsMessage.Builder setSourceName​(java.lang.String sourceName)
        Parameters:
        sourceName - The message's sourceName.

      • appendJsPlaceholderReference

        @CanIgnoreReturnValue
public JsMessage.Builder appendJsPlaceholderReference​(java.lang.String name)
        Appends a placeholder reference to the message.
        Parameters:
        name - placeholder name in the format used in JS code (lowerCamelCaseWithOptional_12_34)

      • appendCanonicalPlaceholderReference

        @CanIgnoreReturnValue
public JsMessage.Builder appendCanonicalPlaceholderReference​(java.lang.String name)
        Appends a placeholder reference to the message.
        Parameters:
        name - placeholder name in the format used in XML files (UPPER_SNAKE_CASE_12_34)

      • appendStringPart

        @CanIgnoreReturnValue
public JsMessage.Builder appendStringPart​(java.lang.String part)
        Appends a translatable string literal to the message.

      • setPlaceholderNameToExampleMap

        @CanIgnoreReturnValue
public JsMessage.Builder setPlaceholderNameToExampleMap​(java.util.Map<java.lang.String,​java.lang.String> map)

      • setPlaceholderNameToOriginalCodeMap

        @CanIgnoreReturnValue
public JsMessage.Builder setPlaceholderNameToOriginalCodeMap​(java.util.Map<java.lang.String,​java.lang.String> map)

      • setDesc

        @CanIgnoreReturnValue
public JsMessage.Builder setDesc​(@Nullable java.lang.String desc)
        Sets the description of the message, which helps translators.

      • setMeaning

        @CanIgnoreReturnValue
public JsMessage.Builder setMeaning​(@Nullable java.lang.String meaning)
        Sets the programmer-specified meaning of this message, which forces this message to translate differently.

      • setAlternateId

        @CanIgnoreReturnValue
public JsMessage.Builder setAlternateId​(@Nullable java.lang.String alternateId)
        Sets the alternate message ID, to be used if the primary ID is not yet translated.

      • setIsHidden

        @CanIgnoreReturnValue
public JsMessage.Builder setIsHidden​(boolean hidden)
        Sets whether the message should be hidden from volunteer translators.

      • setIsAnonymous

        @CanIgnoreReturnValue
public JsMessage.Builder setIsAnonymous​(boolean isAnonymous)

      • setId

        @CanIgnoreReturnValue
public JsMessage.Builder setId​(java.lang.String id)

      • setIsExternalMsg

        @CanIgnoreReturnValue
public JsMessage.Builder setIsExternalMsg​(boolean isExternalMsg)

      • hasParts

        public boolean hasParts()
        Gets whether at least one part has been appended.