Class AffixUtils


  • public class AffixUtils
    extends java.lang.Object
    Performs manipulations on affix patterns: the prefix and suffix strings associated with a decimal format pattern. For example:
    Affix Pattern Example Unescaped (Formatted) String
    abc abc
    ab- ab−
    ab'-' ab-
    ab'' ab'
    To manually iterate over tokens in a literal string, use the following pattern, which is designed to be efficient.
     long tag = 0L;
     while (AffixPatternUtils.hasNext(tag, patternString)) {
         tag = AffixPatternUtils.nextToken(tag, patternString);
         int typeOrCp = AffixPatternUtils.getTypeOrCp(tag);
         switch (typeOrCp) {
         case AffixPatternUtils.TYPE_MINUS_SIGN:
             // Current token is a minus sign.
             break;
         case AffixPatternUtils.TYPE_PLUS_SIGN:
             // Current token is a plus sign.
             break;
         case AffixPatternUtils.TYPE_PERCENT:
             // Current token is a percent sign.
             break;
         // ... other types ...
         default:
             // Current token is an arbitrary code point.
             // The variable typeOrCp is the code point.
             break;
         }
     }
     
    • Field Detail

      • TYPE_CODEPOINT

        private static final int TYPE_CODEPOINT
        Represents a literal character; the value is stored in the code point field.
        See Also:
        Constant Field Values
      • TYPE_MINUS_SIGN

        public static final int TYPE_MINUS_SIGN
        Represents a minus sign symbol '-'.
        See Also:
        Constant Field Values
      • TYPE_PLUS_SIGN

        public static final int TYPE_PLUS_SIGN
        Represents a plus sign symbol '+'.
        See Also:
        Constant Field Values
      • TYPE_APPROXIMATELY_SIGN

        public static final int TYPE_APPROXIMATELY_SIGN
        See Also:
        Constant Field Values
      • TYPE_PERCENT

        public static final int TYPE_PERCENT
        Represents a percent sign symbol '%'.
        See Also:
        Constant Field Values
      • TYPE_PERMILLE

        public static final int TYPE_PERMILLE
        Represents a permille sign symbol '‰'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_SINGLE

        public static final int TYPE_CURRENCY_SINGLE
        Represents a single currency symbol '¤'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_DOUBLE

        public static final int TYPE_CURRENCY_DOUBLE
        Represents a double currency symbol '¤¤'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_TRIPLE

        public static final int TYPE_CURRENCY_TRIPLE
        Represents a triple currency symbol '¤¤¤'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_QUAD

        public static final int TYPE_CURRENCY_QUAD
        Represents a quadruple currency symbol '¤¤¤¤'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_QUINT

        public static final int TYPE_CURRENCY_QUINT
        Represents a quintuple currency symbol '¤¤¤¤¤'.
        See Also:
        Constant Field Values
      • TYPE_CURRENCY_OVERFLOW

        public static final int TYPE_CURRENCY_OVERFLOW
        Represents a sequence of six or more currency symbols.
        See Also:
        Constant Field Values
    • Constructor Detail

      • AffixUtils

        public AffixUtils()
    • Method Detail

      • escape

        public static int escape​(java.lang.CharSequence input,
                                 java.lang.StringBuilder output)
        Takes a string and escapes (quotes) characters that have special meaning in the affix pattern syntax. This function does not reverse-lookup symbols.

        Example input: "-$x"; example output: "'-'$x"

        Parameters:
        input - The string to be escaped.
        output - The string builder to which to append the escaped string.
        Returns:
        The number of chars (UTF-16 code units) appended to the output.
      • unescape

        public static int unescape​(java.lang.CharSequence affixPattern,
                                   FormattedStringBuilder output,
                                   int position,
                                   AffixUtils.SymbolProvider provider,
                                   NumberFormat.Field field)
        Executes the unescape state machine. Replaces the unquoted characters "-", "+", "%", "‰", and "¤" with the corresponding symbols provided by the AffixUtils.SymbolProvider, and inserts the result into the FormattedStringBuilder at the requested location.

        Example input: "'-'¤x"; example output: "-$x"

        Parameters:
        affixPattern - The original string to be unescaped.
        output - The FormattedStringBuilder to mutate with the result.
        position - The index into the FormattedStringBuilder to insert the the string.
        provider - An object to generate locale symbols.
        Returns:
        The length of the string added to affixPattern.
      • containsType

        public static boolean containsType​(java.lang.CharSequence affixPattern,
                                           int type)
        Checks whether the given affix pattern contains at least one token of the given type, which is one of the constants "TYPE_" in AffixUtils.
        Parameters:
        affixPattern - The affix pattern to check.
        type - The token type.
        Returns:
        true if the affix pattern contains the given token type; false otherwise.
      • hasCurrencySymbols

        public static boolean hasCurrencySymbols​(java.lang.CharSequence affixPattern)
        Checks whether the specified affix pattern has any unquoted currency symbols ("¤").
        Parameters:
        affixPattern - The string to check for currency symbols.
        Returns:
        true if the literal has at least one unquoted currency symbol; false otherwise.
      • replaceType

        public static java.lang.String replaceType​(java.lang.CharSequence affixPattern,
                                                   int type,
                                                   char replacementChar)
        Replaces all occurrences of tokens with the given type with the given replacement char.
        Parameters:
        affixPattern - The source affix pattern (does not get modified).
        type - The token type.
        replacementChar - The char to substitute in place of chars of the given token type.
        Returns:
        A string containing the new affix pattern.
      • containsOnlySymbolsAndIgnorables

        public static boolean containsOnlySymbolsAndIgnorables​(java.lang.CharSequence affixPattern,
                                                               UnicodeSet ignorables)
        Returns whether the given affix pattern contains only symbols and ignorables as defined by the given ignorables set.
      • iterateWithConsumer

        public static void iterateWithConsumer​(java.lang.CharSequence affixPattern,
                                               AffixUtils.TokenConsumer consumer)
        Iterates over the affix pattern, calling the TokenConsumer for each token.
      • nextToken

        private static long nextToken​(long tag,
                                      java.lang.CharSequence patternString)
        Returns the next token from the affix pattern.
        Parameters:
        tag - A bitmask used for keeping track of state from token to token. The initial value should be 0L.
        patternString - The affix pattern.
        Returns:
        The bitmask tag to pass to the next call of this method to retrieve the following token (never negative), or -1 if there were no more tokens in the affix pattern.
        See Also:
        hasNext(long, java.lang.CharSequence)
      • hasNext

        private static boolean hasNext​(long tag,
                                       java.lang.CharSequence string)
        Returns whether the affix pattern string has any more tokens to be retrieved from a call to nextToken(long, java.lang.CharSequence).
        Parameters:
        tag - The bitmask tag of the previous token, as returned by nextToken(long, java.lang.CharSequence).
        string - The affix pattern.
        Returns:
        true if there are more tokens to consume; false otherwise.
      • makeTag

        private static long makeTag​(int offset,
                                    int type,
                                    int state,
                                    int cp)
        Encodes the given values into a 64-bit tag.
        • Bits 0-31 => offset (int32)
        • Bits 32-35 => type (uint4)
        • Bits 36-39 => state (uint4)
        • Bits 40-60 => code point (uint21)
        • Bits 61-63 => unused
      • getOffset

        private static int getOffset​(long tag)
      • getType

        private static int getType​(long tag)
      • getState

        private static int getState​(long tag)
      • getCodePoint

        private static int getCodePoint​(long tag)