Package io.deephaven.base.log

Interface LogOutput

All Known Subinterfaces:

LogEntry

All Known Implementing Classes:

DelayedLogEntryImpl, DelayedLogEntryImpl2, LogEntry.Null, LogEntryImpl, LogOutput.Null, LogOutputBaseImpl, LogOutputCsvImpl, LogOutputStringImpl

public interface LogOutput

Collects output for efficient textual logging. The append methods are intended to behave like StringBuilder to the extent possible, but the fast loggers make no pretense about handling Unicode or producing anything but good old ASCII.

Note that although the output will probably be single byte ASCII, we behave like StringBuilder and by the standard overload and promotion rules appending a byte actually appends an integer ("65") not a character ("A").

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LogOutput.LongFormatter
static class	LogOutput.Null
static interface	LogOutput.ObjFormatter<T>
static interface	LogOutput.ObjIntIntFormatter<T>
static interface	LogOutput.ObjObjFormatter<T,U>

Field Summary

Fields

Modifier and Type	Field	Description
static final LogOutput.ObjFormatter<LogOutputAppendable[]>	APPENDABLE_ARRAY_FORMATTER	Formats an array of LogOutputAppendable instances
static final LogOutput.ObjFormatter<Collection<? extends LogOutputAppendable>>	APPENDABLE_COLLECTION_FORMATTER	Formats a Collection of LogOutputAppendable instances
static final LogOutput.ObjFormatter<Object>	BASIC_FORMATTER	Formats an arbitrary object similar to Object.toString()
static final LogOutput.ObjFormatter<boolean[]>	BOOLEAN_ARRAY_FORMATTER	Formats a boolean array
static final LogOutput.ObjFormatter<int[]>	INT_ARRAY_FORMATTER	Formats an int array
static final LogOutput.ObjFormatter<LocalDateTime>	LOCAL_DATE_TIME_FORMATTER	Formats LocalDateTime based on the default timezone
static final LogOutput.LongFormatter	MILLIS_FROM_EPOCH_FORMATTER	Formats long millis from epoch based on the default timezone
static final TimestampBuffer	millisFormatter
static final LogOutput.Null	NULL
static final LogOutput.ObjFormatter<byte[]>	NULL_TERMINATED_STRING_FORMATTER	Formats byte array as a null-terminated string
static final LogOutput.ObjFormatter<SocketAddress>	SOCKADDR_FORMATTER	Formats an InetSocketAddress
static final LogOutput.ObjFormatter<String[]>	STRING_ARRAY_FORMATTER	Formats a String array
static final LogOutput.ObjFormatter<Collection<String>>	STRING_COLLECTION_FORMATTER	Formats a String Collection

Method Summary

Modifier and Type	Method	Description
LogOutput	append(boolean b)
LogOutput	append(byte[] ba)
LogOutput	append(byte[] ba, byte terminator)
LogOutput	append(byte[] ba, int pos, int length)
LogOutput	append(char c)
LogOutput	append(int i)
LogOutput	append(long l)
LogOutput	append(short s)
LogOutput	append(LogOutput.LongFormatter formatter, long n)
<T> LogOutput	append(LogOutput.ObjFormatter<T> objFormatter, T t)
<T> LogOutput	append(LogOutput.ObjIntIntFormatter<T> objFormatter, T t, int nOffset, int nLength)
<T, U> LogOutput	append(LogOutput.ObjObjFormatter<T,U> objObjFormatter, T t, U u)
LogOutput	append(LogOutputAppendable appendable)
default LogOutput	append(Boolean b)
default LogOutput	append(Character c)
LogOutput	append(CharSequence seq)
LogOutput	append(CharSequence seq, int start, int length)
default LogOutput	append(Integer i)
default LogOutput	append(Long l)
default LogOutput	append(Short s)
LogOutput	append(Throwable t)
LogOutput	append(ByteBuffer bb)	Appends the character equivalent of each byte remaining in the given ByteBuffer ([65 66 67] == "ABC" not "656667"), but does not modify the mark, position, or limit of the ByteBuffer.
LogOutput	appendDouble(double f)
default LogOutput	appendDouble(Double f)
LogOutput	appendTimestamp(long utcMillis, TimestampBuffer tb)
LogOutput	appendTimestampMicros(long utcMicros, TimestampBufferMicros tb)
LogOutput	clear()
LogOutput	close()
ByteBuffer	getBuffer(int i)
int	getBufferCount()
int	getEndOfHeaderOffset()
LogOutput	markEndOfHeader()
LogOutput	nf()
LogOutput	nl()
int	relativeSize()
int	size()
LogOutput	start()

Field Details

millisFormatter

static final TimestampBuffer millisFormatter

BASIC_FORMATTER

static final LogOutput.ObjFormatter<Object> BASIC_FORMATTER

Formats an arbitrary object similar to Object.toString()

SOCKADDR_FORMATTER

static final LogOutput.ObjFormatter<SocketAddress> SOCKADDR_FORMATTER

Formats an InetSocketAddress

INT_ARRAY_FORMATTER

static final LogOutput.ObjFormatter<int[]> INT_ARRAY_FORMATTER

Formats an int array

STRING_ARRAY_FORMATTER

static final LogOutput.ObjFormatter<String[]> STRING_ARRAY_FORMATTER

Formats a String array

STRING_COLLECTION_FORMATTER

static final LogOutput.ObjFormatter<Collection<String>> STRING_COLLECTION_FORMATTER

Formats a String Collection

APPENDABLE_ARRAY_FORMATTER

static final LogOutput.ObjFormatter<LogOutputAppendable[]> APPENDABLE_ARRAY_FORMATTER

Formats an array of LogOutputAppendable instances

APPENDABLE_COLLECTION_FORMATTER

static final LogOutput.ObjFormatter<Collection<? extends LogOutputAppendable>> APPENDABLE_COLLECTION_FORMATTER

Formats a Collection of LogOutputAppendable instances

BOOLEAN_ARRAY_FORMATTER

static final LogOutput.ObjFormatter<boolean[]> BOOLEAN_ARRAY_FORMATTER

Formats a boolean array

NULL_TERMINATED_STRING_FORMATTER

static final LogOutput.ObjFormatter<byte[]> NULL_TERMINATED_STRING_FORMATTER

Formats byte array as a null-terminated string

LOCAL_DATE_TIME_FORMATTER

static final LogOutput.ObjFormatter<LocalDateTime> LOCAL_DATE_TIME_FORMATTER

Formats LocalDateTime based on the default timezone

MILLIS_FROM_EPOCH_FORMATTER

static final LogOutput.LongFormatter MILLIS_FROM_EPOCH_FORMATTER

Formats long millis from epoch based on the default timezone

NULL

static final LogOutput.Null NULL

Method Details

start

LogOutput start()

append

LogOutput append(boolean b)

append

LogOutput append(char c)

append

LogOutput append(short s)

append

LogOutput append(int i)

append

LogOutput append(long l)

appendDouble

LogOutput appendDouble(double f)

append

LogOutput append(LogOutputAppendable appendable)

append

LogOutput append(LogOutput.LongFormatter formatter,
 long n)

append

<T> LogOutput append(LogOutput.ObjFormatter<T> objFormatter,
 T t)

append

<T> LogOutput append(LogOutput.ObjIntIntFormatter<T> objFormatter,
 T t,
 int nOffset,
 int nLength)

append

<T,
U> LogOutput append(LogOutput.ObjObjFormatter<T,U> objObjFormatter,
 T t,
 U u)

append

LogOutput append(CharSequence seq)

append

LogOutput append(CharSequence seq,
 int start,
 int length)

append

LogOutput append(ByteBuffer bb)

Appends the character equivalent of each byte remaining in the given ByteBuffer ([65 66 67] == "ABC" not "656667"), but does not modify the mark, position, or limit of the ByteBuffer.

appendTimestamp

LogOutput appendTimestamp(long utcMillis,
 TimestampBuffer tb)

appendTimestampMicros

LogOutput appendTimestampMicros(long utcMicros,
 TimestampBufferMicros tb)

append

LogOutput append(Throwable t)

append

LogOutput append(byte[] ba)

append

LogOutput append(byte[] ba,
 int pos,
 int length)

append

LogOutput append(byte[] ba,
 byte terminator)

append

default LogOutput append(Boolean b)

append

default LogOutput append(Character c)

append

default LogOutput append(Short s)

append

default LogOutput append(Integer i)

append

default LogOutput append(Long l)

appendDouble

default LogOutput appendDouble(Double f)

markEndOfHeader

LogOutput markEndOfHeader()

getEndOfHeaderOffset

int getEndOfHeaderOffset()

nf

LogOutput nf()

nl

LogOutput nl()

close

LogOutput close()

relativeSize

int relativeSize()

size

int size()

getBufferCount

int getBufferCount()

getBuffer

ByteBuffer getBuffer(int i)

clear

LogOutput clear()