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 methods for manipulating Appendable implementations such as StringBuilder and Bytes. These helpers are used throughout the text parsing and formatting code paths.

Method Summary

Modifier and Type	Method and Description
static void	append(@NotNull Appendable sb, double value) Appends value to sb.
static void	append(@NotNull Appendable sb, long value) Appends value in decimal form to sb.
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) Computes the UTF-8 byte length of the provided 8-bit encoded character array.
static long	findUtf8Length(byte[] bytes, byte coder) Returns the number of bytes required to UTF-8 encode the supplied bytes using the given coder representation.
static long	findUtf8Length(char[] chars) Convenience overload of findUtf8Length(char[], int, int) for the whole array.
static long	findUtf8Length(char[] chars, int offset, int length) Returns the UTF-8 byte length of a portion of chars.
static long	findUtf8Length(@NotNull CharSequence str) Determines how many bytes str will occupy when encoded as UTF-8.
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) Decodes length bytes from bs as either UTF-8 or ISO-8859-1 and appends the text to sb.
static void	read8bitAndAppend(@NotNull StreamingDataInput bytes, @NotNull StringBuilder appendable, @NotNull StopCharsTester tester) Reads 8-bit characters from bytes appending each to appendable until tester signals a stop or the input ends.
static void	readUtf8AndAppend(@NotNull StreamingDataInput bytes, @NotNull Appendable appendable, @NotNull StopCharsTester tester) Reads UTF-8 characters from bytes and appends them to appendable until tester signals a stop or the input ends.
static void	readUTFAndAppend(@NotNull StreamingDataInput bytes, @NotNull Appendable appendable, @NotNull StopCharsTester tester) Reads 8-bit characters and appends them to appendable until tester requests a stop.
static void	setCharAt(@NotNull Appendable sb, int index, char ch) Writes ch at index in the supplied Appendable.
static void	setLength(@NotNull Appendable sb, int newLength) Adjusts the logical length of sb.
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

Writes ch at index in the supplied Appendable. Only StringBuilder and Bytes are supported.

Throws:

IllegalArgumentException - if sb is not a supported type

BufferOverflowException - if index exceeds the capacity of the target

parseUtf8

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

Decodes length bytes from bs as either UTF-8 or ISO-8859-1 and appends the text to sb.

Parameters:

utf - when true treat the bytes as UTF-8, otherwise ISO-8859-1

Throws:

UTFDataFormatRuntimeException - if the data is malformed UTF-8

BufferUnderflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

setLength

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

Adjusts the logical length of sb. For Bytes this moves the write position to newLength.

Throws:

IllegalArgumentException

net.openhft.chronicle.core.io.ClosedIllegalStateException

BufferUnderflowException

append

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

Appends value to sb. For Bytes the configured Decimaliser is used.

Throws:

IllegalArgumentException

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

append

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

Appends value in decimal form to sb.

Throws:

IllegalArgumentException

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

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 8-bit characters from bytes appending each to appendable until tester signals a stop or the input ends.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

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 8-bit characters and appends them to appendable until tester requests a stop.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

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 UTF-8 characters from bytes and appends them to appendable until tester signals a stop or the input ends.

Throws:

BufferUnderflowException

IOException

net.openhft.chronicle.core.io.ClosedIllegalStateException

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

Determines how many bytes str will occupy when encoded as UTF-8.

Throws:

IndexOutOfBoundsException

findUtf8Length

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

Returns the number of bytes required to UTF-8 encode the supplied bytes using the given coder representation.

findUtf8Length

public static long findUtf8Length(byte[] chars)

Computes the UTF-8 byte length of the provided 8-bit encoded character array.

findUtf8Length

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

Returns the UTF-8 byte length of a portion of chars.

findUtf8Length

public static long findUtf8Length(char[] chars)

Convenience overload of findUtf8Length(char[], int, int) for the whole array.