net.openhft.chronicle.wire

Class WireDumper

java.lang.Object

net.openhft.chronicle.wire.WireDumper

public class WireDumper
extends Object

Method Summary

Modifier and Type	Method and Description
@NotNull String	asString() Obtains a string representation of the entire content present in the bytes.
@NotNull String	asString(boolean abbrev) Obtains a string representation of the content from the current read position.
@NotNull String	asString(long position, long length) Returns a string representation of the content located at the given position and length in the bytes.
@NotNull String	asString(long position, long length, boolean abbrev) Returns a string representation of the content located at the given position and length in the bytes.
void	dumpAsHexadecimal(@NotNull StringBuilder sb, int len, long readPosition, int sblen) Dumps the content of the byte buffer as a hexadecimal representation into the provided StringBuilder.
boolean	dumpOne(@NotNull StringBuilder sb, @Nullable net.openhft.chronicle.bytes.Bytes<?> buffer) Dumps a single wire entry from the internal byte buffer to the provided StringBuilder.
boolean	dumpOne(@NotNull StringBuilder sb, @Nullable net.openhft.chronicle.bytes.Bytes<?> buffer, boolean abbrev) Dumps a single wire entry from the internal byte buffer to the provided StringBuilder.
static @NotNull WireDumper	of(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Factory method to create a new WireDumper instance given a Bytes object.
static @NotNull WireDumper	of(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean align) Factory method to create a new WireDumper instance given a Bytes object and an alignment preference.
static @NotNull WireDumper	of(@NotNull WireIn wireIn) Factory method to create a new WireDumper instance given a WireIn object.

Methods inherited from class java.lang.Object

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

Method Detail

of

@NotNull
public static @NotNull WireDumper of(@NotNull
                                              @NotNull WireIn wireIn)

Factory method to create a new WireDumper instance given a WireIn object.

Parameters:

wireIn - The WireIn instance to be dumped

Returns:

A new WireDumper instance

of

@NotNull
public static @NotNull WireDumper of(@NotNull
                                              @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes)

Factory method to create a new WireDumper instance given a Bytes object. This method uses default padding alignment.

Parameters:

bytes - The Bytes object containing the raw data to be dumped

Returns:

A new WireDumper instance

of

@NotNull
public static @NotNull WireDumper of(@NotNull
                                              @NotNull net.openhft.chronicle.bytes.Bytes<?> bytes,
                                              boolean align)

Factory method to create a new WireDumper instance given a Bytes object and an alignment preference.

Parameters:

bytes - The Bytes object containing the raw data to be dumped

align - Boolean value indicating whether to align the dumped data

Returns:

A new WireDumper instance

asString

@NotNull
public @NotNull String asString()

Obtains a string representation of the entire content present in the bytes. This method uses default abbreviated format.

Returns:

String representation of the content

asString

@NotNull
public @NotNull String asString(boolean abbrev)

Obtains a string representation of the content from the current read position. The length of content to be represented is determined by the remaining bytes to be read.

Parameters:

abbrev - Boolean value indicating whether to use abbreviated format

Returns:

String representation of the content from the current read position

asString

@NotNull
public @NotNull String asString(long position,
                                         long length)

Returns a string representation of the content located at the given position and length in the bytes. This method uses the default abbreviated format.

Parameters:

position - Starting position of the content to be represented

length - Length of the content to be represented

Returns:

String representation of the specified content

asString

@NotNull
public @NotNull String asString(long position,
                                         long length,
                                         boolean abbrev)

Returns a string representation of the content located at the given position and length in the bytes. The method provides an option to use an abbreviated format.

Parameters:

position - Starting position of the content to be represented

length - Length of the content to be represented

abbrev - Boolean value indicating whether to use abbreviated format

Returns:

String representation of the specified content

dumpOne

public boolean dumpOne(@NotNull
                       @NotNull StringBuilder sb,
                       @Nullable
                       @Nullable net.openhft.chronicle.bytes.Bytes<?> buffer)

Dumps a single wire entry from the internal byte buffer to the provided StringBuilder. This method uses the default abbreviated format.

Parameters:

sb - StringBuilder to which the wire entry will be appended

buffer - Temporary buffer to assist in dumping the wire entry

Returns:

Boolean value indicating whether the dump was successful

dumpOne

public boolean dumpOne(@NotNull
                       @NotNull StringBuilder sb,
                       @Nullable
                       @Nullable net.openhft.chronicle.bytes.Bytes<?> buffer,
                       boolean abbrev)

Dumps a single wire entry from the internal byte buffer to the provided StringBuilder. This method provides an option to use an abbreviated format.

Parameters:

sb - StringBuilder to which the wire entry will be appended

buffer - Temporary buffer to assist in dumping the wire entry

abbrev - Boolean value indicating whether to use abbreviated format

Returns:

Boolean value indicating whether the dump was successful

dumpAsHexadecimal

public void dumpAsHexadecimal(@NotNull
                              @NotNull StringBuilder sb,
                              int len,
                              long readPosition,
                              int sblen)

Dumps the content of the byte buffer as a hexadecimal representation into the provided StringBuilder. It positions the bytes at the specified read position, converts the content to hexadecimal, and sets the resulting string to the StringBuilder.

Parameters:

sb - The StringBuilder to which the hexadecimal string will be appended.

len - The length or number of bytes to read and convert to hexadecimal.

readPosition - The starting position in the byte buffer from which to start reading.

sblen - The length to reset the StringBuilder to. This is typically used to overwrite any existing content.