org.basex.util

Class TokenBuilder

java.lang.Object

org.basex.util.TokenBuilder

public final class TokenBuilder
extends java.lang.Object

This class serves as an efficient constructor for byte arrays. It bears some resemblance to Java's StringBuilder.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field and Description
static byte	HLINE Half new line.
static byte	MARK Mark flag.
static byte	NLINE New line.

Constructor Summary

Constructors

Constructor and Description
TokenBuilder() Empty constructor.
TokenBuilder(byte[] t) Constructor, specifying an initial token.
TokenBuilder(int i) Constructor, specifying an initial array size.
TokenBuilder(java.lang.String s) Constructor, specifying an initial string.

Method Summary

Methods

Modifier and Type	Method and Description
TokenBuilder	add(byte[] b) Adds a byte array to the token.
TokenBuilder	add(byte[] b, int s, int e) Adds a partial byte array to the token.
TokenBuilder	add(int ch) Adds the specified UTF8 character.
TokenBuilder	add(java.lang.String s) Adds a string to the token.
TokenBuilder	addByte(byte b) Adds a byte to the token.
TokenBuilder	addExt(java.lang.Object str, java.lang.Object... ext) Adds the string representation of an object: objects of type Throwable are converted to a string representation via Util.message(java.lang.Throwable). objects of type Class are converted via Util.name(Class). null references are replaced by the string "null". byte arrays are directly inserted as tokens. for all other typed, Object.toString() is called. The specified string may contain "%" characters as place holders.
TokenBuilder	addLong(long i) Adds a number to the token.
TokenBuilder	addSep(java.lang.Object[] s, java.lang.String sep) Adds multiple strings to the token, separated by the specified string.
TokenBuilder	bold() Adds a bold flag.
int	cl(int p) Returns the codepoint length of the specified byte.
int	cp(int p) Returns the codepoint at the specified position.
void	delete(int p, int s) Deletes bytes from the token.
byte[]	finish() Returns the token as byte array.
byte	get(int p) Returns the byte at the specified position.
TokenBuilder	hline() Adds a half new line.
TokenBuilder	insert(int pos, int ch) Inserts the specified UTF8 character.
boolean	isEmpty() Tests if the token is empty.
TokenBuilder	nline() Adds a new line.
TokenBuilder	norm() Adds a norm flag.
TokenBuilder	reset() Resets the token buffer.
void	set(byte b, int p) Sets a byte at the specified position.
int	size() Returns the number of bytes.
void	size(int s) Sets the number of bytes.
java.lang.String	toString()
TokenBuilder	trim() Trims leading and trailing whitespaces.

Methods inherited from class java.lang.Object

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

Field Detail

HLINE

public static final byte HLINE

Half new line.

See Also:

Constant Field Values

MARK

public static final byte MARK

Mark flag.

See Also:

Constant Field Values

NLINE

public static final byte NLINE

New line.

See Also:

Constant Field Values

Constructor Detail

TokenBuilder

public TokenBuilder()

Empty constructor.

TokenBuilder

public TokenBuilder(int i)

Constructor, specifying an initial array size.

Parameters:

i - size

TokenBuilder

public TokenBuilder(java.lang.String s)

Constructor, specifying an initial string.

Parameters:

s - initial string

TokenBuilder

public TokenBuilder(byte[] t)

Constructor, specifying an initial token.

Parameters:

t - initial token

Method Detail

size

public int size()

Returns the number of bytes.

Returns:

number of bytes

size

public void size(int s)

Sets the number of bytes. Note that no bound check are performed by this method.

Parameters:

s - number of bytes

isEmpty

public boolean isEmpty()

Tests if the token is empty.

Returns:

result of check

reset

public TokenBuilder reset()

Resets the token buffer.

Returns:

self reference

bold

public TokenBuilder bold()

Adds a bold flag. This method should only be called to control text rendering in the visual front end.

Returns:

self reference

norm

public TokenBuilder norm()

Adds a norm flag. This method should only be called to control text rendering in the visual front end.

Returns:

self reference

nline

public TokenBuilder nline()

Adds a new line. This method should only be called to control text rendering in the visual front end.

Returns:

self reference

hline

public TokenBuilder hline()

Adds a half new line. This method should only be called to control text rendering in the visual front end.

Returns:

self reference

add

public TokenBuilder add(int ch)

Adds the specified UTF8 character.

Parameters:

ch - the character to be added

Returns:

self reference

insert

public TokenBuilder insert(int pos,
                  int ch)

Inserts the specified UTF8 character.

Parameters:

pos - insertion index

ch - the character to be added

Returns:

self reference

cp

public int cp(int p)

Returns the codepoint at the specified position.

Parameters:

p - position

Returns:

character

cl

public int cl(int p)

Returns the codepoint length of the specified byte.

Parameters:

p - position

Returns:

character

get

public byte get(int p)

Returns the byte at the specified position.

Parameters:

p - position

Returns:

byte

set

public void set(byte b,
       int p)

Sets a byte at the specified position.

Parameters:

b - byte to be set

p - position

delete

public void delete(int p,
          int s)

Deletes bytes from the token.

Parameters:

p - position

s - number of bytes to be removed

addByte

public TokenBuilder addByte(byte b)

Adds a byte to the token. ByteList instances should be preferred for the construction of pure byte arrays.

Parameters:

b - the byte to be added

Returns:

self reference

addLong

public TokenBuilder addLong(long i)

Adds a number to the token.

Parameters:

i - the integer to be added

Returns:

self reference

add

public TokenBuilder add(byte[] b)

Adds a byte array to the token.

Parameters:

b - the character array to be added

Returns:

self reference

add

public TokenBuilder add(byte[] b,
               int s,
               int e)

Adds a partial byte array to the token.

Parameters:

b - the character array to be added

s - start position

e - end position

Returns:

self reference

add

public TokenBuilder add(java.lang.String s)

Adds a string to the token.

Parameters:

s - the string to be added

Returns:

self reference

addSep

public TokenBuilder addSep(java.lang.Object[] s,
                  java.lang.String sep)

Adds multiple strings to the token, separated by the specified string.

Parameters:

s - the string to be added

sep - separator

Returns:

self reference

addExt

public TokenBuilder addExt(java.lang.Object str,
                  java.lang.Object... ext)

Adds the string representation of an object:

• objects of type Throwable are converted to a string representation via Util.message(java.lang.Throwable).
• objects of type Class are converted via Util.name(Class).
• null references are replaced by the string "null".
• byte arrays are directly inserted as tokens.
• for all other typed, Object.toString() is called.

The specified string may contain "%" characters as place holders. All place holders will be replaced by the specified extensions. If a digit is specified after the place holder character, it will be interpreted as insertion position.

Parameters:

str - string to be extended

ext - optional extensions

Returns:

self reference

trim

public TokenBuilder trim()

Trims leading and trailing whitespaces.

Returns:

self reference

finish

public byte[] finish()

Returns the token as byte array.

Returns:

character array

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object