Package org.xbill.DNS

Class Tokenizer

java.lang.Object

org.xbill.DNS.Tokenizer

All Implemented Interfaces:

AutoCloseable

public class Tokenizer
extends Object
implements AutoCloseable

Tokenizer is used to parse DNS records and zones from text format,

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Tokenizer.Token

Field Summary

Fields

Modifier and Type	Field	Description
static final int	COMMENT	A comment; only returned when wantComment is set
private Tokenizer.Token	current
private static final String	DEFAULT_DELIMITERS
private String	delimiters
static final int	EOF	End of file
static final int	EOL	End of line
private String	filename
static final int	IDENTIFIER	An identifier (unquoted string)
private final PushbackInputStream	is
private int	line
private int	multiline
static final int	QUOTED_STRING	A quoted string
private static final String	QUOTES
private boolean	quoting
private final StringBuilder	sb
private boolean	ungottenToken
private boolean	wantClose
static final int	WHITESPACE	Whitespace; only returned when wantWhitespace is set

Constructor Summary

Constructors

Constructor	Description
Tokenizer(File f)	Creates a Tokenizer from a file.
Tokenizer(InputStream is)	Creates a Tokenizer from an arbitrary input stream.
Tokenizer(String s)	Creates a Tokenizer from a string.

Method Summary

Modifier and Type	Method	Description
private void	checkUnbalancedParens()
void	close()	Closes any files opened by this tokenizer.
TextParseException	exception(String s)	Creates an exception which includes the current state in the error message
Tokenizer.Token	get()	Gets the next token from a tokenizer, ignoring whitespace and comments.
Tokenizer.Token	get(boolean wantWhitespace, boolean wantComment)	Gets the next token from a tokenizer.
InetAddress	getAddress(int family)	Gets the next token from a tokenizer and converts it to an IP Address.
byte[]	getAddressBytes(int family)	Gets the next token from a tokenizer and converts it to a byte array containing an IP address.
byte[]	getBase32String(base32 b32)	Gets the next token from a tokenizer and decodes it as base32.
byte[]	getBase64()	Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the base64 encoded data to a byte array.
byte[]	getBase64(boolean required)	Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the base64 encoded data to a byte array.
private int	getChar()
void	getEOL()	Gets the next token from a tokenizer, which must be an EOL or EOF.
byte[]	getHex()	Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the hex encoded data to a byte array.
byte[]	getHex(boolean required)	Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the hex encoded data to a byte array.
byte[]	getHexString()	Gets the next token from a tokenizer and decodes it as hex.
String	getIdentifier()	Gets the next token from a tokenizer, ensures it is an unquoted string, and converts it to a string.
private String	getIdentifier(String expected)
long	getLong()	Gets the next token from a tokenizer and converts it to a long.
Name	getName(Name origin)	Gets the next token from a tokenizer and converts it to a name.
String	getString()	Gets the next token from a tokenizer and converts it to a string.
long	getTTL()	Gets the next token from a tokenizer and parses it as a TTL.
long	getTTLLike()	Gets the next token from a tokenizer and parses it as if it were a TTL.
int	getUInt16()	Gets the next token from a tokenizer and converts it to an unsigned 16 bit integer.
long	getUInt32()	Gets the next token from a tokenizer and converts it to an unsigned 32 bit integer.
int	getUInt8()	Gets the next token from a tokenizer and converts it to an unsigned 8 bit integer.
private String	remainingStrings()	Returns a concatenation of the remaining strings from a Tokenizer.
private Tokenizer.Token	setCurrentToken(int type, StringBuilder value)
private int	skipWhitespace()
void	unget()	Returns a token to the stream, so that it will be returned by the next call to get().
private void	ungetChar(int c)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_DELIMITERS

private static final String DEFAULT_DELIMITERS

See Also:

• Constant Field Values

QUOTES

private static final String QUOTES

See Also:

• Constant Field Values

EOF

public static final int EOF

End of file

See Also:

• Constant Field Values

EOL

public static final int EOL

End of line

See Also:

• Constant Field Values

WHITESPACE

public static final int WHITESPACE

Whitespace; only returned when wantWhitespace is set

See Also:

• Constant Field Values

IDENTIFIER

public static final int IDENTIFIER

An identifier (unquoted string)

See Also:

• Constant Field Values

QUOTED_STRING

public static final int QUOTED_STRING

A quoted string

See Also:

• Constant Field Values

COMMENT

public static final int COMMENT

A comment; only returned when wantComment is set

See Also:

• Constant Field Values

is

private final PushbackInputStream is

ungottenToken

private boolean ungottenToken

multiline

private int multiline

quoting

private boolean quoting

delimiters

private String delimiters

current

private Tokenizer.Token current

sb

private final StringBuilder sb

wantClose

private boolean wantClose

filename

private String filename

line

private int line

Constructor Details

Tokenizer

public Tokenizer(InputStream is)

Creates a Tokenizer from an arbitrary input stream.

Parameters:

is - The InputStream to tokenize.

Tokenizer

public Tokenizer(String s)

Creates a Tokenizer from a string.

Parameters:

s - The String to tokenize.

Tokenizer

public Tokenizer(File f)
          throws FileNotFoundException

Creates a Tokenizer from a file.

Parameters:

f - The File to tokenize.

Throws:

FileNotFoundException

Method Details

getChar

private int getChar()
             throws IOException

Throws:

IOException

ungetChar

private void ungetChar(int c)
                throws IOException

Throws:

IOException

skipWhitespace

private int skipWhitespace()
                    throws IOException

Throws:

IOException

checkUnbalancedParens

private void checkUnbalancedParens()
                            throws TextParseException

Throws:

TextParseException

get

public Tokenizer.Token get(boolean wantWhitespace,
 boolean wantComment)
                    throws IOException

Gets the next token from a tokenizer.

Parameters:

wantWhitespace - If true, leading whitespace will be returned as a token.

wantComment - If true, comments are returned as tokens.

Returns:

The next token in the stream.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

setCurrentToken

private Tokenizer.Token setCurrentToken(int type,
 StringBuilder value)

get

public Tokenizer.Token get()
                    throws IOException

Gets the next token from a tokenizer, ignoring whitespace and comments.

Returns:

The next token in the stream.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

unget

public void unget()

Returns a token to the stream, so that it will be returned by the next call to get().

Throws:

IllegalStateException - There are already ungotten tokens.

getString

public String getString()
                 throws IOException

Gets the next token from a tokenizer and converts it to a string.

Returns:

The next token in the stream, as a string.

Throws:

TextParseException - The input was invalid or not a string.

IOException - An I/O error occurred.

getIdentifier

private String getIdentifier(String expected)
                      throws IOException

Throws:

IOException

getIdentifier

public String getIdentifier()
                     throws IOException

Gets the next token from a tokenizer, ensures it is an unquoted string, and converts it to a string.

Returns:

The next token in the stream, as a string.

Throws:

TextParseException - The input was invalid or not an unquoted string.

IOException - An I/O error occurred.

getLong

public long getLong()
             throws IOException

Gets the next token from a tokenizer and converts it to a long.

Returns:

The next token in the stream, as a long.

Throws:

TextParseException - The input was invalid or not a long.

IOException - An I/O error occurred.

getUInt32

public long getUInt32()
               throws IOException

Gets the next token from a tokenizer and converts it to an unsigned 32 bit integer.

Returns:

The next token in the stream, as an unsigned 32 bit integer.

Throws:

TextParseException - The input was invalid or not an unsigned 32 bit integer.

IOException - An I/O error occurred.

getUInt16

public int getUInt16()
              throws IOException

Gets the next token from a tokenizer and converts it to an unsigned 16 bit integer.

Returns:

The next token in the stream, as an unsigned 16 bit integer.

Throws:

TextParseException - The input was invalid or not an unsigned 16 bit integer.

IOException - An I/O error occurred.

getUInt8

public int getUInt8()
             throws IOException

Gets the next token from a tokenizer and converts it to an unsigned 8 bit integer.

Returns:

The next token in the stream, as an unsigned 8 bit integer.

Throws:

TextParseException - The input was invalid or not an unsigned 8 bit integer.

IOException - An I/O error occurred.

getTTL

public long getTTL()
            throws IOException

Gets the next token from a tokenizer and parses it as a TTL.

Returns:

The next token in the stream, as an unsigned 32 bit integer.

Throws:

TextParseException - The input was not valid.

IOException - An I/O error occurred.

See Also:

• TTL

getTTLLike

public long getTTLLike()
                throws IOException

Gets the next token from a tokenizer and parses it as if it were a TTL.

Returns:

The next token in the stream, as an unsigned 32 bit integer.

Throws:

TextParseException - The input was not valid.

IOException - An I/O error occurred.

See Also:

• TTL

getName

public Name getName(Name origin)
             throws IOException

Gets the next token from a tokenizer and converts it to a name.

Parameters:

origin - The origin to append to relative names.

Returns:

The next token in the stream, as a name.

Throws:

TextParseException - The input was invalid or not a valid name.

IOException - An I/O error occurred.

RelativeNameException - The parsed name was relative, even with the origin.

See Also:

• Name

getAddressBytes

public byte[] getAddressBytes(int family)
                       throws IOException

Gets the next token from a tokenizer and converts it to a byte array containing an IP address.

Parameters:

family - The address family.

Returns:

The next token in the stream, as an byte array representing an IP address.

Throws:

TextParseException - The input was invalid or not a valid address.

IOException - An I/O error occurred.

See Also:

• Address

getAddress

public InetAddress getAddress(int family)
                       throws IOException

Gets the next token from a tokenizer and converts it to an IP Address.

Parameters:

family - The address family.

Returns:

The next token in the stream, as an InetAddress

Throws:

TextParseException - The input was invalid or not a valid address.

IOException - An I/O error occurred.

See Also:

• Address

getEOL

public void getEOL()
            throws IOException

Gets the next token from a tokenizer, which must be an EOL or EOF.

Throws:

TextParseException - The input was invalid or not an EOL or EOF token.

IOException - An I/O error occurred.

remainingStrings

private String remainingStrings()
                         throws IOException

Returns a concatenation of the remaining strings from a Tokenizer.

Throws:

IOException

getBase64

public byte[] getBase64(boolean required)
                 throws IOException

Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the base64 encoded data to a byte array.

Parameters:

required - If true, an exception will be thrown if no strings remain; otherwise null be be returned.

Returns:

The byte array containing the decoded strings, or null if there were no strings to decode.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

getBase64

public byte[] getBase64()
                 throws IOException

Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the base64 encoded data to a byte array.

Returns:

The byte array containing the decoded strings, or null if there were no strings to decode.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

getHex

public byte[] getHex(boolean required)
              throws IOException

Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the hex encoded data to a byte array.

Parameters:

required - If true, an exception will be thrown if no strings remain; otherwise null be be returned.

Returns:

The byte array containing the decoded strings, or null if there were no strings to decode.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

getHex

public byte[] getHex()
              throws IOException

Gets the remaining string tokens until an EOL/EOF is seen, concatenates them together, and converts the hex encoded data to a byte array.

Returns:

The byte array containing the decoded strings, or null if there were no strings to decode.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

getHexString

public byte[] getHexString()
                    throws IOException

Gets the next token from a tokenizer and decodes it as hex.

Returns:

The byte array containing the decoded string.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

getBase32String

public byte[] getBase32String(base32 b32)
                       throws IOException

Gets the next token from a tokenizer and decodes it as base32.

Parameters:

b32 - The base32 context to decode with.

Returns:

The byte array containing the decoded string.

Throws:

TextParseException - The input was invalid.

IOException - An I/O error occurred.

exception

public TextParseException exception(String s)

Creates an exception which includes the current state in the error message

Parameters:

s - The error message to include.

Returns:

The exception to be thrown

close

public void close()

Closes any files opened by this tokenizer.

Specified by:

close in interface AutoCloseable