io.milton.dns.record

Class Mnemonic

java.lang.Object

io.milton.dns.record.Mnemonic

public class Mnemonic
extends Object

A utility class for converting between numeric codes and mnemonics for those codes. Mnemonics are case insensitive.

Author:

Brian Wellington

Field Summary

Fields

Modifier and Type	Field and Description
static int	CASE_LOWER
static int	CASE_SENSITIVE
static int	CASE_UPPER

Constructor Summary

Constructors

Constructor and Description
Mnemonic(String description, int wordcase) Creates a new Mnemonic table.

Method Summary

Modifier and Type	Method and Description
void	add(int val, String str) Defines the text representation of a numeric value.
void	addAlias(int val, String str) Defines an additional text representation of a numeric value.
void	addAll(Mnemonic source) Copies all mnemonics from one table into another.
void	check(int val) Checks that a numeric value is within the range [0..max]
String	getText(int val) Gets the text mnemonic corresponding to a numeric value.
int	getValue(String str) Gets the numeric value corresponding to a text mnemonic.
void	setMaximum(int max) Sets the maximum numeric value
void	setNumericAllowed(boolean numeric) Sets whether numeric values stored in strings are acceptable.
void	setPrefix(String prefix) Sets the prefix to use when converting to and from values that don't have mnemonics.
static Integer	toInteger(int val) Converts an int into a possibly cached Integer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CASE_SENSITIVE

public static final int CASE_SENSITIVE

See Also:

Constant Field Values

CASE_UPPER

public static final int CASE_UPPER

See Also:

Constant Field Values

CASE_LOWER

public static final int CASE_LOWER

See Also:

Constant Field Values

Constructor Detail

Mnemonic

public Mnemonic(String description,
                int wordcase)

Creates a new Mnemonic table.

Parameters:

description - A short description of the mnemonic to use when

wordcase - Whether to convert strings into uppercase, lowercase, or leave them unchanged. throwing exceptions.

Method Detail

setMaximum

public void setMaximum(int max)

Sets the maximum numeric value

setPrefix

public void setPrefix(String prefix)

Sets the prefix to use when converting to and from values that don't have mnemonics.

setNumericAllowed

public void setNumericAllowed(boolean numeric)

Sets whether numeric values stored in strings are acceptable.

toInteger

public static Integer toInteger(int val)

Converts an int into a possibly cached Integer.

check

public void check(int val)

Checks that a numeric value is within the range [0..max]

add

public void add(int val,
                String str)

Defines the text representation of a numeric value.

Parameters:

val - The numeric value

string - The text string

addAlias

public void addAlias(int val,
                     String str)

Defines an additional text representation of a numeric value. This will be used by getValue(), but not getText().

Parameters:

val - The numeric value

string - The text string

addAll

public void addAll(Mnemonic source)

Copies all mnemonics from one table into another.

Parameters:

val - The numeric value

string - The text string

Throws:

IllegalArgumentException - The wordcases of the Mnemonics do not match.

getText

public String getText(int val)

Gets the text mnemonic corresponding to a numeric value.

Parameters:

val - The numeric value

Returns:

The corresponding text mnemonic.

getValue

public int getValue(String str)

Gets the numeric value corresponding to a text mnemonic.

Parameters:

str - The text mnemonic

Returns:

The corresponding numeric value, or -1 if there is none