Package io.deephaven.io.log

Interface LogEntry

All Superinterfaces:

LogOutput, LogSink.Element

All Known Implementing Classes:

DelayedLogEntryImpl, DelayedLogEntryImpl2, LogEntry.Null, LogEntryImpl

public interface LogEntry
extends LogOutput, LogSink.Element

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	LogEntry.Null

Nested classes/interfaces inherited from interface io.deephaven.base.log.LogOutput

LogOutput.LongFormatter, LogOutput.ObjFormatter<T>, LogOutput.ObjIntIntFormatter<T>, LogOutput.ObjObjFormatter<T,U>

Field Summary

Fields

Modifier and Type	Field	Description
static final LogEntry.Null	NULL

Fields inherited from interface io.deephaven.base.log.LogOutput

APPENDABLE_ARRAY_FORMATTER, APPENDABLE_COLLECTION_FORMATTER, BASIC_FORMATTER, BOOLEAN_ARRAY_FORMATTER, INT_ARRAY_FORMATTER, LOCAL_DATE_TIME_FORMATTER, MILLIS_FROM_EPOCH_FORMATTER, millisFormatter, NULL_TERMINATED_STRING_FORMATTER, SOCKADDR_FORMATTER, STRING_ARRAY_FORMATTER, STRING_COLLECTION_FORMATTER

Method Summary

Modifier and Type	Method	Description
LogEntry	append(boolean b)
LogEntry	append(byte[] ba)
LogEntry	append(byte[] ba, byte terminator)
LogEntry	append(byte[] ba, int pos, int length)
LogEntry	append(char c)
LogEntry	append(int i)
LogEntry	append(long l)
LogEntry	append(short s)
LogEntry	append(LogOutput.LongFormatter formatter, long n)
<T> LogEntry	append(LogOutput.ObjFormatter<T> objFormatter, T t)
<T> LogEntry	append(LogOutput.ObjIntIntFormatter<T> objFormatter, T t, int nOffset, int nLength)
<T, U> LogEntry	append(LogOutput.ObjObjFormatter<T,U> objObjFormatter, T t, U u)
LogEntry	append(LogOutputAppendable appendable)
default LogEntry	append(Boolean b)
default LogEntry	append(Character c)
LogEntry	append(CharSequence seq)
LogEntry	append(CharSequence seq, int start, int length)
default LogEntry	append(Integer i)
default LogEntry	append(Long l)
default LogEntry	append(Short s)
LogEntry	append(Throwable t)
LogEntry	append(ByteBuffer buffer)	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.
LogEntry	appendDouble(double f)
default LogEntry	appendDouble(double doubleValue, int decimalPlaces)	Append a double to the exact given number of decimal places, rounding half up.
default LogEntry	appendDouble(double doubleValue, int decimalPlaces, int maxTrailingZeroesToDiscard)	Append a double rounded to the given number of decimal places, rounding half up.
default LogEntry	appendDouble(Double f)
LogEntry	appendTimestamp(long utcMillis, TimestampBuffer tb)
LogEntry	appendTimestampMicros(long utcMicros, TimestampBufferMicros tb)
void	end()	Completes the log entry.
void	endl()	Completes the log entry with a newline.
LogEntry	nf()
LogEntry	nl()
LogEntry	start(LogSink sink, LogLevel level)
LogEntry	start(LogSink sink, LogLevel level, long currentTimeMicros)
LogEntry	start(LogSink sink, LogLevel level, long currentTimeMicros, Throwable t)

Methods inherited from interface io.deephaven.base.log.LogOutput

clear, close, getBuffer, getBufferCount, getEndOfHeaderOffset, markEndOfHeader, relativeSize, size, start

Methods inherited from interface io.deephaven.io.log.LogSink.Element

getLevel, getThrowable, getTimestampMicros, writing, written

Field Details

NULL

static final LogEntry.Null NULL

Method Details

start

LogEntry start(LogSink sink,
 LogLevel level)

start

LogEntry start(LogSink sink,
 LogLevel level,
 long currentTimeMicros)

start

LogEntry start(LogSink sink,
 LogLevel level,
 long currentTimeMicros,
 Throwable t)

end

void end()

Completes the log entry. Callers should not use this after completion. End or endl() should be called exactly once.

endl

void endl()

Completes the log entry with a newline. Callers should not use this after completion. Endl or end() should be called exactly once.

append

LogEntry append(boolean b)

Specified by:

append in interface LogOutput

append

LogEntry append(char c)

Specified by:

append in interface LogOutput

append

LogEntry append(short s)

Specified by:

append in interface LogOutput

append

LogEntry append(int i)

Specified by:

append in interface LogOutput

append

LogEntry append(long l)

Specified by:

append in interface LogOutput

appendDouble

LogEntry appendDouble(double f)

Specified by:

appendDouble in interface LogOutput

append

LogEntry append(LogOutputAppendable appendable)

Specified by:

append in interface LogOutput

append

LogEntry append(LogOutput.LongFormatter formatter,
 long n)

Specified by:

append in interface LogOutput

append

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

Specified by:

append in interface LogOutput

append

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

Specified by:

append in interface LogOutput

append

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

Specified by:

append in interface LogOutput

append

LogEntry append(CharSequence seq)

Specified by:

append in interface LogOutput

append

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

Specified by:

append in interface LogOutput

append

LogEntry append(ByteBuffer buffer)

Description copied from interface: LogOutput

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.

Specified by:

append in interface LogOutput

appendTimestamp

LogEntry appendTimestamp(long utcMillis,
 TimestampBuffer tb)

Specified by:

appendTimestamp in interface LogOutput

appendTimestampMicros

LogEntry appendTimestampMicros(long utcMicros,
 TimestampBufferMicros tb)

Specified by:

appendTimestampMicros in interface LogOutput

append

LogEntry append(Throwable t)

Specified by:

append in interface LogOutput

append

LogEntry append(byte[] ba)

Specified by:

append in interface LogOutput

append

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

Specified by:

append in interface LogOutput

append

LogEntry append(byte[] ba,
 byte terminator)

Specified by:

append in interface LogOutput

append

default LogEntry append(Boolean b)

Specified by:

append in interface LogOutput

append

default LogEntry append(Character c)

Specified by:

append in interface LogOutput

append

default LogEntry append(Short s)

Specified by:

append in interface LogOutput

append

default LogEntry append(Integer i)

Specified by:

append in interface LogOutput

append

default LogEntry append(Long l)

Specified by:

append in interface LogOutput

appendDouble

default LogEntry appendDouble(Double f)

Specified by:

appendDouble in interface LogOutput

appendDouble

default LogEntry appendDouble(double doubleValue,
 int decimalPlaces)

Append a double to the exact given number of decimal places, rounding half up.

Parameters:

doubleValue - a double value to append to the logEntry

decimalPlaces - a positive integer between 0 and 9

Returns:

the resulting LogEntry

appendDouble

default LogEntry appendDouble(double doubleValue,
 int decimalPlaces,
 int maxTrailingZeroesToDiscard)

Append a double rounded to the given number of decimal places, rounding half up. If to the given decimal places of precision

Parameters:

doubleValue - a double value to append to the logEntry

decimalPlaces - a positive integer between 0 and 9 for the target number of decimal places to round to

maxTrailingZeroesToDiscard - a positive integer between 0 and 9 for the maximum trailing zeroes (if any) to discard from the fractional part of the result. The fractional part of the result will have always at least (decimalPlaces - maxTrailingZeroesToDiscard) places.

Returns:

the resulting LogEntry

nf

LogEntry nf()

Specified by:

nf in interface LogOutput

nl

LogEntry nl()

Specified by:

nl in interface LogOutput