flogger-api/io.spine.logging.flogger.parameter/Parameter

Parameter

public abstract class Parameter

An abstract representation of a parameter for a message template.

Note that this is implemented as a class (rather than via an interface) because it is very helpful to have explicit checks for the index values and count to ensure we can calculate reliable low bounds for the number of arguments a template can accept.

Note that all subclasses of Parameter must be immutable and thread safe.

See also

<a href="https://github.com/google/flogger/blob/cb9e836a897d36a78309ee8badf5cad4e6a2d3d8/api/src/main/java/com/google/common/flogger/parameter/Parameter.java">

Original Java code of Google Flogger

Inheritors

SimpleParameter

BraceStyleParameter

DateTimeParameter

Constructors

protected void Parameter(FormatOptions options, int index)

Constructs a parameter to format an argument using specified formatting options.

Properties

public final int index

Functions

protected abstract void accept(ParameterVisitor visitor, Object value)

public final void accept(ParameterVisitor visitor, Array<Object> args)

public abstract String getFormat()

Returns the printf format string specified for this parameter (eg, "%d" or "%tc").

getFormatOptions

protected final FormatOptions getFormatOptions()

Returns the formatting options.

public final int getIndex()

Returns the index of the argument to be processed by this parameter.