Mnemonic.java 5.5 KB
Newer Older
Alexander Ivanov's avatar
Alexander Ivanov committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
// Copyright (c) 2004 Brian Wellington (bwelling@xbill.org)

package org.xbill.DNS;

import java.util.HashMap;

/**
 * A utility class for converting between numeric codes and mnemonics
 * for those codes.  Mnemonics are case insensitive.
 *
 * @author Brian Wellington
 */

class Mnemonic {

16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    private static Integer cachedInts[] = new Integer[64];

    static {
        for (int i = 0; i < cachedInts.length; i++) {
            cachedInts[i] = new Integer(i);
        }
    }

    /* Strings are case-sensitive. */
    static final int CASE_SENSITIVE = 1;

    /* Strings will be stored/searched for in uppercase. */
    static final int CASE_UPPER = 2;

    /* Strings will be stored/searched for in lowercase. */
    static final int CASE_LOWER = 3;

    private HashMap strings;
    private HashMap values;
    private String description;
    private int wordcase;
    private String prefix;
    private int max;
    private boolean numericok;

    /**
     * Creates a new Mnemonic table.
     *
     * @param description A short description of the mnemonic to use when
     * @param wordcase    Whether to convert strings into uppercase, lowercase,
     *                    or leave them unchanged.
     *                    throwing exceptions.
     */
    public Mnemonic(String description, int wordcase) {
        this.description = description;
        this.wordcase = wordcase;
        strings = new HashMap();
        values = new HashMap();
        max = Integer.MAX_VALUE;
    }

    /**
     * Sets the maximum numeric value
     */
    public void
    setMaximum(int max) {
        this.max = max;
    }

    /**
     * Sets the prefix to use when converting to and from values that don't
     * have mnemonics.
     */
    public void
    setPrefix(String prefix) {
        this.prefix = sanitize(prefix);
    }

    /**
     * Sets whether numeric values stored in strings are acceptable.
     */
    public void
    setNumericAllowed(boolean numeric) {
        this.numericok = numeric;
    }

    /**
     * Converts an int into a possibly cached Integer.
     */
    public static Integer
    toInteger(int val) {
        if (val >= 0 && val < cachedInts.length)
            return (cachedInts[val]);
        return new Integer(val);
    }

    /**
     * Checks that a numeric value is within the range [0..max]
     */
    public void
    check(int val) {
        if (val < 0 || val > max) {
            throw new IllegalArgumentException(description + " " + val +
                    "is out of range");
        }
    }

    /* Converts a String to the correct case. */
    private String
    sanitize(String str) {
        if (wordcase == CASE_UPPER)
            return str.toUpperCase();
        else if (wordcase == CASE_LOWER)
            return str.toLowerCase();
        return str;
    }

    private int
    parseNumeric(String s) {
        try {
            int val = Integer.parseInt(s);
            if (val >= 0 && val <= max)
                return val;
        } catch (NumberFormatException e) {
        }
        return -1;
    }

    /**
     * Defines the text representation of a numeric value.
     *
     * @param val    The numeric value
     * @param string The text string
     */
    public void
    add(int val, String str) {
        check(val);
        Integer value = toInteger(val);
        str = sanitize(str);
        strings.put(str, value);
        values.put(value, str);
    }

    /**
     * Defines an additional text representation of a numeric value.  This will
     * be used by getValue(), but not getText().
     *
     * @param val    The numeric value
     * @param string The text string
     */
    public void
    addAlias(int val, String str) {
        check(val);
        Integer value = toInteger(val);
        str = sanitize(str);
        strings.put(str, value);
    }

    /**
     * Copies all mnemonics from one table into another.
     *
     * @param val    The numeric value
     * @param string The text string
     * @throws IllegalArgumentException The wordcases of the Mnemonics do not
     *                                  match.
     */
    public void
    addAll(Mnemonic source) {
        if (wordcase != source.wordcase)
            throw new IllegalArgumentException(source.description +
                    ": wordcases do not match");
        strings.putAll(source.strings);
        values.putAll(source.values);
    }

    /**
     * Gets the text mnemonic corresponding to a numeric value.
     *
     * @param val The numeric value
     * @return The corresponding text mnemonic.
     */
    public String
    getText(int val) {
        check(val);
        String str = (String) values.get(toInteger(val));
        if (str != null)
            return str;
        str = Integer.toString(val);
        if (prefix != null)
            return prefix + str;
        return str;
    }

    /**
     * Gets the numeric value corresponding to a text mnemonic.
     *
     * @param str The text mnemonic
     * @return The corresponding numeric value, or -1 if there is none
     */
    public int
    getValue(String str) {
        str = sanitize(str);
        Integer value = (Integer) strings.get(str);
        if (value != null) {
            return value.intValue();
        }
        if (prefix != null) {
            if (str.startsWith(prefix)) {
                int val = parseNumeric(str.substring(prefix.length()));
                if (val >= 0) {
                    return val;
                }
            }
        }
        if (numericok) {
            return parseNumeric(str);
        }
        return -1;
    }
Alexander Ivanov's avatar
Alexander Ivanov committed
215 216

}