net.openhft.chronicle.wire

Class WireDumper

java.lang.Object

net.openhft.chronicle.wire.WireDumper

public class WireDumper
extends Object

The WireDumper class provides utility methods to obtain a human-readable dump representation of WireIn content. This class can operate on different WireIn or Bytes inputs and is designed to facilitate debugging and logging.

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) Dumps a specific region of the wire content, starting at position for length bytes, as a string.
@NotNull String	asString(long position, long length, boolean abbrev) Dumps a specific region of the wire content, starting at position for length bytes, as a string.
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) Reads and dumps a single size-prefixed message from the wire into the supplied sb.
boolean	dumpOne(@NotNull StringBuilder sb, @Nullable net.openhft.chronicle.bytes.Bytes<?> buffer, boolean abbrev) Reads and dumps a single size-prefixed message from the wire into the supplied sb.
static @NotNull WireDumper	of(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes) Creates a WireDumper for the given Bytes instance, implicitly treating it as a BinaryWire.
static @NotNull WireDumper	of(@NotNull net.openhft.chronicle.bytes.Bytes<?> bytes, boolean align) Creates a WireDumper for the given Bytes instance, implicitly treating it as a BinaryWire.
static @NotNull WireDumper	of(@NotNull WireIn wireIn) Creates a WireDumper for the given WireIn instance.

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)

Creates a WireDumper for the given WireIn instance.

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)

Creates a WireDumper for the given Bytes instance, implicitly treating it as a BinaryWire. This method uses the 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)

Creates a WireDumper for the given Bytes instance, implicitly treating it as a BinaryWire. The align parameter controls whether padding is assumed (see AbstractWire.DEFAULT_USE_PADDING).

Parameters:

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

align - Whether to use padding alignment

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)

Dumps a specific region of the wire content, starting at position for length bytes, as a string.

Parameters:

position - The starting byte position in the wire's underlying buffer

length - The number of bytes to dump from the starting position

Returns:

A string representation of the specified wire content region

asString

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

Dumps a specific region of the wire content, starting at position for length bytes, as a string.

Parameters:

position - The starting byte position in the wire's underlying buffer

length - The number of bytes to dump from the starting position

abbrev - If true, long content within individual messages might be abbreviated

Returns:

A string representation of the specified wire content region

dumpOne

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

Reads and dumps a single size-prefixed message from the wire into the supplied sb. This method uses the default abbreviated format.

Parameters:

sb - The StringBuilder to append the dumped message to

buffer - A temporary Bytes buffer used if the source message is binary

Returns:

true if the end of the wire was reached, false otherwise

dumpOne

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

Reads and dumps a single size-prefixed message from the wire into the supplied sb.

Parameters:

sb - The StringBuilder to append the dumped message to

buffer - A temporary Bytes buffer used if the source message is binary; may be null

abbrev - If true, abbreviates content

Returns:

true if the end of the wire was reached, false otherwise

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 append the hexadecimal dump to

len - The number of bytes to read from bytes and dump

readPosition - The starting position in bytes to read from

sblen - The length to which sb should be reset before appending the hex dump