net.openhft.chronicle.bytes

Interface HexDumpBytesDescription<B extends HexDumpBytesDescription<B>>

All Known Subinterfaces:

Bytes<U>, BytesOut<U>

All Known Implementing Classes:

AbstractBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface HexDumpBytesDescription<B extends HexDumpBytesDescription<B>>

This interface is for additional description to be added to HexDumpBytes

Method Summary

Modifier and Type	Method and Description
default B	adjustHexDumpIndentation(int n) Adjust the indent for nested data
default boolean	retainedHexDumpDescription() Do these Bytes support saving comments as descriptions for fields.
default B	writeHexDumpDescription(CharSequence comment) Add comment as appropriate for the toHexString format

Method Detail

retainedHexDumpDescription

default boolean retainedHexDumpDescription()

Do these Bytes support saving comments as descriptions for fields.

Returns:

true if comments are for field descriptions

writeHexDumpDescription

default B writeHexDumpDescription(CharSequence comment)
                           throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

Add comment as appropriate for the toHexString format

Parameters:

comment - to add (or ignore)

Returns:

this

Throws:

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

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

adjustHexDumpIndentation

default B adjustHexDumpIndentation(int n)
                            throws IllegalStateException

Adjust the indent for nested data

Parameters:

n - +1 indent in, -1 reduce indenting

Returns:

this.

Throws:

IllegalStateException