net.openhft.chronicle.bytes

Enum AppendableUtil

java.lang.Object

java.lang.Enum<AppendableUtil>

net.openhft.chronicle.bytes.AppendableUtil

All Implemented Interfaces:

Serializable, Comparable<AppendableUtil>

public enum AppendableUtil
extends Enum<AppendableUtil>

Utility class for working with Appendable objects such as StringBuilder and Bytes.

Method Summary

Modifier and Type	Method and Description
static void	append(@NotNull Appendable sb, double value) Appends a double value to the given Appendable.
static void	append(@NotNull Appendable sb, long value) Appends a long value to the given Appendable.
static <C extends Appendable & CharSequence> void	append(C a, CharSequence cs, long start, long len) Appends a subsequence of the specified CharSequence to an Appendable.
static <C extends Appendable & CharSequence> void	append(C sb, String str) Appends a string to an Appendable that also implements CharSequence.
static long	findUtf8Length(byte[] chars) Calculates the length of a byte array in UTF-8 format.
static long	findUtf8Length(byte[] bytes, byte coder) Calculates the length of a byte array in UTF-8 format.
static long	findUtf8Length(char[] chars) Calculates the length of a character array in UTF-8 format.
static long	findUtf8Length(char[] chars, int offset, int length) Calculates the length of a character array in UTF-8 format, from a given offset up to the specified length.
static long	findUtf8Length(@NotNull CharSequence str) Calculates the length of a CharSequence in UTF-8 format.
static void	parse8bit_SB1(@NotNull Bytes<?> bytes, @NotNull StringBuilder sb, int length) Parses a sequence of 8-bit characters from the given Bytes input and appends them to a StringBuilder.
static void	parse8bit(@NotNull StreamingDataInput bytes, Appendable appendable, int utflen) Parses a sequence of 8-bit characters from the given StreamingDataInput and appends them to an Appendable.
static void	parseUtf8(@NotNull BytesStore<?,?> bs, StringBuilder sb, boolean utf, int length) Parses a UTF-8 BytesStore into a StringBuilder.
static void	read8bitAndAppend(@NotNull StreamingDataInput bytes, @NotNull StringBuilder appendable, @NotNull StopCharsTester tester) Reads an 8-bit character from a StreamingDataInput and appends it to a StringBuilder until a stop character as defined by the given StopCharsTester is encountered.
static void	readUtf8AndAppend(@NotNull StreamingDataInput bytes, @NotNull Appendable appendable, @NotNull StopCharsTester tester) Reads a UTF-8 encoded character from a StreamingDataInput and appends it to an Appendable until a stop character as defined by the given StopCharsTester is encountered.
static void	readUTFAndAppend(@NotNull StreamingDataInput bytes, @NotNull Appendable appendable, @NotNull StopCharsTester tester) Reads an 8-bit character from a StreamingDataInput and appends it to an Appendable until a stop character as defined by the given StopCharsTester is encountered.
static void	setCharAt(@NotNull Appendable sb, int index, char ch) Sets a character at a specified index in the given Appendable.
static void	setLength(@NotNull Appendable sb, int newLength) Sets the length of the given Appendable.
static AppendableUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static AppendableUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static AppendableUtil[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AppendableUtil c : AppendableUtil.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AppendableUtil valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

setCharAt

public static void setCharAt(@NotNull
                             @NotNull Appendable sb,
                             int index,
                             char ch)
                      throws IllegalArgumentException,
                             BufferOverflowException

Sets a character at a specified index in the given Appendable.

Parameters:

sb - the Appendable to modify

index - the index at which to set the character

ch - the character to set

Throws:

IllegalArgumentException - If the Appendable is not of type StringBuilder or Bytes

BufferOverflowException - If the index is larger than the buffer's capacity

parseUtf8

public static void parseUtf8(@NotNull
                             @NotNull BytesStore<?,?> bs,
                             StringBuilder sb,
                             boolean utf,
                             int length)
                      throws UTFDataFormatRuntimeException,
                             BufferUnderflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException

Parses a UTF-8 BytesStore into a StringBuilder.

Parameters:

bs - the BytesStore to parse

sb - the StringBuilder to append to

utf - whether to parse as UTF-8

length - the length of characters to parse

Throws:

UTFDataFormatRuntimeException - If invalid UTF-8 sequence is encountered

BufferUnderflowException - If the BytesStore doesn't contain enough data

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

setLength

public static void setLength(@NotNull
                             @NotNull Appendable sb,
                             int newLength)
                      throws IllegalArgumentException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             BufferUnderflowException

Sets the length of the given Appendable.

Parameters:

sb - the Appendable to modify

newLength - the new length to set

Throws:

IllegalArgumentException - If the Appendable is not of type StringBuilder or Bytes

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

BufferUnderflowException - If the new length is greater than the Bytes's capacity

append

public static void append(@NotNull
                          @NotNull Appendable sb,
                          double value)
                   throws IllegalArgumentException,
                          BufferOverflowException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException

Appends a double value to the given Appendable.

Parameters:

sb - the Appendable to append to

value - the double value to append

Throws:

IllegalArgumentException - If the Appendable is not of type StringBuilder or Bytes

BufferOverflowException - If there is not enough space in the Bytes to append the value

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

append

public static void append(@NotNull
                          @NotNull Appendable sb,
                          long value)
                   throws IllegalArgumentException,
                          BufferOverflowException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException

Appends a long value to the given Appendable.

Parameters:

sb - the Appendable to append to

value - the long value to append

Throws:

IllegalArgumentException - If the Appendable is not of type StringBuilder or Bytes

BufferOverflowException - If there is not enough space in the Bytes to append the value

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

append

public static <C extends Appendable & CharSequence> void append(@NotNull
                                                                C sb,
                                                                String str)

Appends a string to an Appendable that also implements CharSequence.

Parameters:

sb - the Appendable to append to

str - the String to append

read8bitAndAppend

public static void read8bitAndAppend(@NotNull
                                     @NotNull StreamingDataInput bytes,
                                     @NotNull
                                     @NotNull StringBuilder appendable,
                                     @NotNull
                                     @NotNull StopCharsTester tester)
                              throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Reads an 8-bit character from a StreamingDataInput and appends it to a StringBuilder until a stop character as defined by the given StopCharsTester is encountered.

Parameters:

bytes - the StreamingDataInput to read from

appendable - the StringBuilder to append to

tester - the StopCharsTester defining the stop character

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

readUTFAndAppend

public static void readUTFAndAppend(@NotNull
                                    @NotNull StreamingDataInput bytes,
                                    @NotNull
                                    @NotNull Appendable appendable,
                                    @NotNull
                                    @NotNull StopCharsTester tester)
                             throws BufferUnderflowException,
                                    net.openhft.chronicle.core.io.ClosedIllegalStateException

Reads an 8-bit character from a StreamingDataInput and appends it to an Appendable until a stop character as defined by the given StopCharsTester is encountered.

Parameters:

bytes - the StreamingDataInput to read from

appendable - the Appendable to append to

tester - the StopCharsTester defining the stop character

Throws:

BufferUnderflowException - If the StreamingDataInput is exhausted

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

readUtf8AndAppend

public static void readUtf8AndAppend(@NotNull
                                     @NotNull StreamingDataInput bytes,
                                     @NotNull
                                     @NotNull Appendable appendable,
                                     @NotNull
                                     @NotNull StopCharsTester tester)
                              throws BufferUnderflowException,
                                     IOException,
                                     net.openhft.chronicle.core.io.ClosedIllegalStateException

Reads a UTF-8 encoded character from a StreamingDataInput and appends it to an Appendable until a stop character as defined by the given StopCharsTester is encountered.

Parameters:

bytes - the StreamingDataInput to read from

appendable - the Appendable to append to

tester - the StopCharsTester defining the stop character

Throws:

BufferUnderflowException - If the StreamingDataInput is exhausted

IOException - If an I/O error occurs

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

parse8bit_SB1

public static void parse8bit_SB1(@NotNull
                                 @NotNull Bytes<?> bytes,
                                 @NotNull
                                 @NotNull StringBuilder sb,
                                 int length)
                          throws BufferUnderflowException,
                                 net.openhft.chronicle.core.io.ClosedIllegalStateException

Parses a sequence of 8-bit characters from the given Bytes input and appends them to a StringBuilder.

Parameters:

bytes - the input Bytes to read from

sb - the StringBuilder to append the characters to

length - the number of characters to read

Throws:

BufferUnderflowException - If there are not enough characters available in the input

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

parse8bit

public static void parse8bit(@NotNull
                             @NotNull StreamingDataInput bytes,
                             Appendable appendable,
                             int utflen)
                      throws BufferUnderflowException,
                             IOException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException

Parses a sequence of 8-bit characters from the given StreamingDataInput and appends them to an Appendable.

Parameters:

bytes - the input StreamingDataInput to read from

appendable - the Appendable to append the characters to

utflen - the number of characters to read

Throws:

BufferUnderflowException - If there are not enough characters available in the input

IOException - If an I/O error occurs

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

append

public static <C extends Appendable & CharSequence> void append(C a,
                                                                CharSequence cs,
                                                                long start,
                                                                long len)
                                                         throws ArithmeticException,
                                                                BufferUnderflowException,
                                                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                                BufferOverflowException

Appends a subsequence of the specified CharSequence to an Appendable.

Parameters:

a - the Appendable to append the characters to

cs - the CharSequence to read characters from

start - the starting index of the subsequence

len - the number of characters in the subsequence

Throws:

ArithmeticException - If an arithmetic error occurs

BufferUnderflowException - If there are not enough characters available in the CharSequence

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

BufferOverflowException - If the Appendable cannot accept more characters

findUtf8Length

public static long findUtf8Length(@NotNull
                                  @NotNull CharSequence str)
                           throws IndexOutOfBoundsException

Calculates the length of a CharSequence in UTF-8 format.

Parameters:

str - the CharSequence to calculate the length of

Returns:

the length of the CharSequence in UTF-8

Throws:

IndexOutOfBoundsException - If the CharSequence has invalid indices

findUtf8Length

public static long findUtf8Length(byte[] bytes,
                                  byte coder)

Calculates the length of a byte array in UTF-8 format.

Parameters:

bytes - the byte array to calculate the length of

coder - a coder indicating the type of the content

Returns:

the length of the byte array in UTF-8

findUtf8Length

public static long findUtf8Length(byte[] chars)

Calculates the length of a byte array in UTF-8 format.

Parameters:

chars - the byte array to calculate the length of

Returns:

the length of the byte array in UTF-8

findUtf8Length

public static long findUtf8Length(char[] chars,
                                  int offset,
                                  int length)

Calculates the length of a character array in UTF-8 format, from a given offset up to the specified length.

Parameters:

chars - the character array to calculate the length of

offset - the starting index in the character array

length - the number of characters to include in the calculation

Returns:

the length of the specified segment of the character array in UTF-8

findUtf8Length

public static long findUtf8Length(char[] chars)

Calculates the length of a character array in UTF-8 format.

Parameters:

chars - the character array to calculate the length of

Returns:

the length of the character array in UTF-8