net.openhft.chronicle.bytes

Interface BytesComment<B extends BytesComment<B>>

All Known Subinterfaces:

Bytes<Underlying>, BytesOut<Underlying>

All Known Implementing Classes:

AbstractBytes, EnbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, NativeBytes.NativeSubBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesComment<B extends BytesComment<B>>

Method Summary

Modifier and Type	Method and Description
default B	comment(CharSequence comment) Add comment as approriate for the toHexString format
default B	indent(int n) Adjust the indent for nested data
default boolean	retainsComments() Do these Bytes support saving comments

Method Detail

retainsComments

default boolean retainsComments()

Do these Bytes support saving comments

Returns:

true if comments are kept

comment

default B comment(CharSequence comment)
           throws IllegalStateException

Add comment as approriate for the toHexString format

Parameters:

comment - to add (or ignore)

Returns:

this

Throws:

IllegalStateException

indent

default B indent(int n)
          throws IllegalStateException

Adjust the indent for nested data

Parameters:

n - +1 indent in, -1 reduce indenting

Returns:

this.

Throws:

IllegalStateException