net.openhft.chronicle.bytes

Enum BytesUtil

java.lang.Object

java.lang.Enum<BytesUtil>

net.openhft.chronicle.bytes.BytesUtil

All Implemented Interfaces:

Serializable, Comparable<BytesUtil>

public enum BytesUtil
extends Enum<BytesUtil>

Method Summary

Modifier and Type	Method and Description
static void	appendBytesFromStart(@NotNull Bytes<?> bytes, long startPosition, @NotNull StringBuilder sb)
static void	appendUtf8(@NotNull StreamingDataOutput out, @NotNull CharSequence cs)
static int	asInt(@NotNull String str)
static boolean	bytesEqual(@Nullable CharSequence cs, @NotNull RandomDataInput bs, long offset, int length)
static boolean	bytesEqual(@NotNull RandomDataInput a, long offset, @NotNull RandomDataInput second, long secondOffset, long len)
static boolean	byteToBoolean(byte b)
static void	combineDoubleNewline(Bytes<?> bytes) If the last two characters were a newline, rewind one character so there is only one newline.
static void	copy8bit(BytesStore bs, long addressForWrite, long length)
static boolean	equals(Object o1, Object o2)
static String	findFile(@NotNull String name)
static boolean	isTriviallyCopyable(@NotNull Class<?> clazz) Is the whole class trivially copyable
static boolean	isTriviallyCopyable(Class clazz, int offset, int length) Are all the fields in the range given trivially copyable
static long	padOffset(long from)
static void	parseUtf8(@NotNull StreamingDataInput in, Appendable appendable, int utflen)
static void	read8ByteAlignPadding(Bytes<?> bytes)
static Bytes<?>	readFile(@NotNull String name)
static void	readMarshallable(@NotNull ReadBytesMarshallable marshallable, BytesIn<?> bytes)
static long	readStopBit(@NotNull StreamingDataInput in)
static void	reverse(Bytes<?> text, int start)
static long	roundNup(double d, long factor)
static long	roundUpTo64ByteAlign(long x)
static long	roundUpTo8ByteAlign(long x)
static int	stopBitLength(long n)
static @NotNull char[]	toCharArray(@NotNull Bytes<?> bytes)
static @NotNull char[]	toCharArray(@NotNull Bytes<?> bytes, long position, int length)
static String	toDebugString(@NotNull RandomDataInput bytes, long start, long maxLength)
static int	triviallyCopyableLength(Class clazz) Return the length of trivially copyable fields, note references are ignored as they are not trivially copyable.
static int[]	triviallyCopyableRange(Class clazz)
static int	triviallyCopyableStart(Class clazz) Return the first byte of trivially copyable fields.
static BytesUtil	valueOf(String name) Returns the enum constant of this type with the specified name.
static BytesUtil[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
static void	write8ByteAlignPadding(Bytes<?> bytes)
static void	writeFile(String file, Bytes<byte[]> bytes)
static void	writeMarshallable(@NotNull WriteBytesMarshallable marshallable, BytesOut<?> bytes)
static long	writeStopBit(BytesStore bs, long offset, long n)
static long	writeStopBit(long addr, long n)
static void	writeStopBit(@NotNull StreamingDataOutput out, long n)

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 BytesUtil[] 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 (BytesUtil c : BytesUtil.values())
    System.out.println(c);

Returns:

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

valueOf

public static BytesUtil 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

isTriviallyCopyable

public static boolean isTriviallyCopyable(@NotNull
                                          @NotNull Class<?> clazz)

Is the whole class trivially copyable

Parameters:

clazz - to check

Returns:

true if the whole class is trivially copyable

isTriviallyCopyable

public static boolean isTriviallyCopyable(Class clazz,
                                          int offset,
                                          int length)

Are all the fields in the range given trivially copyable

Parameters:

clazz - to check

offset - start of field area

length - of the field area

Returns:

true if the fields in range are trivially copyable.

triviallyCopyableRange

public static int[] triviallyCopyableRange(Class clazz)

triviallyCopyableStart

public static int triviallyCopyableStart(Class clazz)

Return the first byte of trivially copyable fields.

Parameters:

clazz - to examine

Returns:

the first byte copyable

triviallyCopyableLength

public static int triviallyCopyableLength(Class clazz)

Return the length of trivially copyable fields, note references are ignored as they are not trivially copyable.

Parameters:

clazz - to examine

Returns:

the length of data

findFile

public static String findFile(@NotNull
                              @NotNull String name)
                       throws FileNotFoundException

Throws:

FileNotFoundException

readFile

public static Bytes<?> readFile(@NotNull
                                @NotNull String name)
                         throws IOException

Throws:

IOException

writeFile

public static void writeFile(String file,
                             Bytes<byte[]> bytes)
                      throws IOException

Throws:

IOException

bytesEqual

public static boolean bytesEqual(@NotNull
                                 @NotNull RandomDataInput a,
                                 long offset,
                                 @NotNull
                                 @NotNull RandomDataInput second,
                                 long secondOffset,
                                 long len)
                          throws BufferUnderflowException,
                                 IllegalStateException

Throws:

BufferUnderflowException

IllegalStateException

bytesEqual

public static boolean bytesEqual(@Nullable
                                 @Nullable CharSequence cs,
                                 @NotNull
                                 @NotNull RandomDataInput bs,
                                 long offset,
                                 int length)
                          throws IllegalStateException,
                                 BufferUnderflowException

Throws:

IllegalStateException

BufferUnderflowException

equals

public static boolean equals(Object o1,
                             Object o2)

asInt

public static int asInt(@NotNull
                        @NotNull String str)

stopBitLength

public static int stopBitLength(long n)

toCharArray

@NotNull
public static @NotNull char[] toCharArray(@NotNull
                                                   @NotNull Bytes<?> bytes)
                                            throws ArithmeticException,
                                                   IllegalStateException,
                                                   BufferUnderflowException

Throws:

ArithmeticException

IllegalStateException

BufferUnderflowException

toCharArray

@NotNull
public static @NotNull char[] toCharArray(@NotNull
                                                   @NotNull Bytes<?> bytes,
                                                   long position,
                                                   int length)
                                            throws IllegalStateException,
                                                   BufferUnderflowException

Throws:

IllegalStateException

BufferUnderflowException

readStopBit

public static long readStopBit(@NotNull
                               @NotNull StreamingDataInput in)
                        throws net.openhft.chronicle.core.io.IORuntimeException,
                               IllegalStateException

Throws:

net.openhft.chronicle.core.io.IORuntimeException

IllegalStateException

writeStopBit

public static void writeStopBit(@NotNull
                                @NotNull StreamingDataOutput out,
                                long n)
                         throws IllegalStateException,
                                BufferOverflowException

Throws:

IllegalStateException

BufferOverflowException

writeStopBit

public static long writeStopBit(BytesStore bs,
                                long offset,
                                long n)
                         throws IllegalStateException,
                                BufferOverflowException

Returns:

the resulting offset

Throws:

IllegalStateException

BufferOverflowException

writeStopBit

public static long writeStopBit(long addr,
                                long n)
                         throws IllegalStateException,
                                BufferOverflowException

Returns:

the resulting address

Throws:

IllegalStateException

BufferOverflowException

parseUtf8

public static void parseUtf8(@NotNull
                             @NotNull StreamingDataInput in,
                             Appendable appendable,
                             int utflen)
                      throws UTFDataFormatRuntimeException,
                             IllegalStateException,
                             BufferUnderflowException

Throws:

UTFDataFormatRuntimeException

IllegalStateException

BufferUnderflowException

appendUtf8

public static void appendUtf8(@NotNull
                              @NotNull StreamingDataOutput out,
                              @NotNull
                              @NotNull CharSequence cs)
                       throws IndexOutOfBoundsException

Throws:

IndexOutOfBoundsException

appendBytesFromStart

public static void appendBytesFromStart(@NotNull
                                        @NotNull Bytes<?> bytes,
                                        long startPosition,
                                        @NotNull
                                        @NotNull StringBuilder sb)
                                 throws IllegalStateException

Throws:

IllegalStateException

readMarshallable

public static void readMarshallable(@NotNull
                                    @NotNull ReadBytesMarshallable marshallable,
                                    BytesIn<?> bytes)

writeMarshallable

public static void writeMarshallable(@NotNull
                                     @NotNull WriteBytesMarshallable marshallable,
                                     BytesOut<?> bytes)
                              throws IllegalStateException,
                                     BufferOverflowException,
                                     ArithmeticException,
                                     BufferUnderflowException

Throws:

IllegalStateException

BufferOverflowException

ArithmeticException

BufferUnderflowException

byteToBoolean

public static boolean byteToBoolean(byte b)

roundUpTo64ByteAlign

public static long roundUpTo64ByteAlign(long x)

roundUpTo8ByteAlign

public static long roundUpTo8ByteAlign(long x)

read8ByteAlignPadding

public static void read8ByteAlignPadding(Bytes<?> bytes)
                                  throws IllegalStateException,
                                         BufferUnderflowException

Throws:

IllegalStateException

BufferUnderflowException

write8ByteAlignPadding

public static void write8ByteAlignPadding(Bytes<?> bytes)
                                   throws BufferOverflowException,
                                          IllegalStateException

Throws:

BufferOverflowException

IllegalStateException

toDebugString

public static String toDebugString(@NotNull
                                   @NotNull RandomDataInput bytes,
                                   long start,
                                   long maxLength)
                            throws IllegalStateException,
                                   BufferUnderflowException,
                                   ArithmeticException

Throws:

IllegalStateException

BufferUnderflowException

ArithmeticException

copy8bit

public static void copy8bit(BytesStore bs,
                            long addressForWrite,
                            long length)

reverse

public static void reverse(Bytes<?> text,
                           int start)

roundNup

public static long roundNup(double d,
                            long factor)

padOffset

public static long padOffset(long from)

combineDoubleNewline

public static void combineDoubleNewline(Bytes<?> bytes)

If the last two characters were a newline, rewind one character so there is only one newline.

Parameters:

bytes - to check and trim as needed.