Package io.deephaven.enterprise.schema.internal

Class LogFormatLogger

java.lang.Object

io.deephaven.enterprise.schema.internal.LogFormatLogger

Direct Known Subclasses:

LogFormatBufferedLogger, LogFormatEncodersLogger

public abstract class LogFormatLogger
extends Object

A LogFormat logger.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	LogFormatLogger.Builder<T extends LogFormatLogger,B extends LogFormatLogger.Builder<T,B>>
static final class	LogFormatLogger.Xml	The XML.

Constructor Summary

Constructors

Constructor	Description
LogFormatLogger()

Method Summary

Modifier and Type	Method	Description
abstract String	className()	The logger's class name.
final boolean	hasSupportDependency()	Whether the generated class has a dependency on the Deephaven "support" package.
boolean	includeRowFlags()	By default, is false.
int	maxEntrySize()	The maximum row size in bytes a row entry is allowed to encode into.
Map<String,LogFormatLoggerObjectInput>	objectInputsByName()
abstract List<LogFormatLoggerObjectInput>	objectInputTypes()
final LogFormatLoggerParam	parameter(String name)	Get the parameter by name.
abstract List<LogFormatLoggerParam>	parameters()	The parameters.
Map<String,LogFormatLoggerParam>	parametersByName()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LogFormatLogger

public LogFormatLogger()

Method Details

className

public abstract String className()

The logger's class name.

Returns:

the class name

includeRowFlags

@Default
public boolean includeRowFlags()

By default, is false.

Returns:

should the log and row population methods include the row flags byte?

maxEntrySize

@Default
public int maxEntrySize()

The maximum row size in bytes a row entry is allowed to encode into. By default, is BinaryStoreV2Constants.MAX_ENTRY_SIZE. Must be in the range [11, BinaryStoreV2Constants.MAX_ENTRY_SIZE]. Callers are encouraged to set this to a more appropriate size for their specific Schema.

Returns:

the max entry size

objectInputTypes

public abstract List<LogFormatLoggerObjectInput> objectInputTypes()

Returns:

the log function ObjectInputs (for POJOs).

parameters

public abstract List<LogFormatLoggerParam> parameters()

The parameters.

Returns:

the parameters

parameter

public final LogFormatLoggerParam parameter(String name)

Get the parameter by name. Throws an exception if the parameter is not present.

Parameters:

name - the name

Returns:

the parameter

hasSupportDependency

public final boolean hasSupportDependency()

Whether the generated class has a dependency on the Deephaven "support" package.

Returns:

whether the generated class has a dependency on the Deephaven "support" package.

objectInputsByName

@Derived
public Map<String,LogFormatLoggerObjectInput> objectInputsByName()

parametersByName

@Derived
public Map<String,LogFormatLoggerParam> parametersByName()