flogger-api/io.spine.logging.flogger/FloggerApi/NoOp

NoOp

public class NoOp<API extends FloggerApi<API>> implements FloggerApi<API>

An implementation of FloggerApi which does nothing and discards all parameters.

This class (or a subclass in the case of an extended API) should be returned whenever logging is definitely disabled (e.g. when the log level is too low).

Constructors

Link copied to clipboard
public void FloggerApi.NoOp()

Functions

Link copied to clipboard
public final API atMostEvery(int n, TimeUnit unit)
Modifies the current log statement to be emitted at most once per specified time period.
Link copied to clipboard
public final API every(int n)
Modifies the current log statement to be emitted at most one-in-N times.
Link copied to clipboard
public final boolean isEnabled()
Returns true if logging is enabled at the level implied for this API, according to the current logger backend.
Link copied to clipboard
public final void log()
Terminal log statement when a message is not required.
public final void log(String msg)
Logs the given literal string without interpreting any argument placeholders.
public final void log(String msg, byte p1)
public final void log(String msg, char p1)
public final void log(String msg, int p1)
public final void log(String msg, long p1)
public final void log(String msg, short p1)
public final void log(String msg, boolean p1, boolean p2)
public final void log(String msg, boolean p1, byte p2)
public final void log(String msg, boolean p1, char p2)
public final void log(String msg, boolean p1, double p2)
public final void log(String msg, boolean p1, float p2)
public final void log(String msg, boolean p1, int p2)
public final void log(String msg, boolean p1, @Nullable() Object p2)
public final void log(String msg, boolean p1, long p2)
public final void log(String msg, boolean p1, short p2)
public final void log(String msg, byte p1, boolean p2)
public final void log(String msg, byte p1, byte p2)
public final void log(String msg, byte p1, char p2)
public final void log(String msg, byte p1, double p2)
public final void log(String msg, byte p1, float p2)
public final void log(String msg, byte p1, int p2)
public final void log(String msg, byte p1, @Nullable() Object p2)
public final void log(String msg, byte p1, long p2)
public final void log(String msg, byte p1, short p2)
public final void log(String msg, char p1, boolean p2)
public final void log(String msg, char p1, byte p2)
public final void log(String msg, char p1, char p2)
public final void log(String msg, char p1, double p2)
public final void log(String msg, char p1, float p2)
public final void log(String msg, char p1, int p2)
public final void log(String msg, char p1, @Nullable() Object p2)
public final void log(String msg, char p1, long p2)
public final void log(String msg, char p1, short p2)
public final void log(String msg, double p1, boolean p2)
public final void log(String msg, double p1, byte p2)
public final void log(String msg, double p1, char p2)
public final void log(String msg, double p1, double p2)
public final void log(String msg, double p1, float p2)
public final void log(String msg, double p1, int p2)
public final void log(String msg, double p1, @Nullable() Object p2)
public final void log(String msg, double p1, long p2)
public final void log(String msg, double p1, short p2)
public final void log(String msg, float p1, boolean p2)
public final void log(String msg, float p1, byte p2)
public final void log(String msg, float p1, char p2)
public final void log(String msg, float p1, double p2)
public final void log(String msg, float p1, float p2)
public final void log(String msg, float p1, int p2)
public final void log(String msg, float p1, @Nullable() Object p2)
public final void log(String msg, float p1, long p2)
public final void log(String msg, float p1, short p2)
public final void log(String msg, int p1, boolean p2)
public final void log(String msg, int p1, byte p2)
public final void log(String msg, int p1, char p2)
public final void log(String msg, int p1, double p2)
public final void log(String msg, int p1, float p2)
public final void log(String msg, int p1, int p2)
public final void log(String msg, int p1, @Nullable() Object p2)
public final void log(String msg, int p1, long p2)
public final void log(String msg, int p1, short p2)
public final void log(String msg, @Nullable() Object p1, boolean p2)
public final void log(String msg, @Nullable() Object p1, byte p2)
public final void log(String msg, @Nullable() Object p1, char p2)
public final void log(String msg, @Nullable() Object p1, double p2)
public final void log(String msg, @Nullable() Object p1, float p2)
public final void log(String msg, @Nullable() Object p1, int p2)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2)
public final void log(String msg, @Nullable() Object p1, long p2)
public final void log(String msg, @Nullable() Object p1, short p2)
public final void log(String msg, long p1, boolean p2)
public final void log(String msg, long p1, byte p2)
public final void log(String msg, long p1, char p2)
public final void log(String msg, long p1, double p2)
public final void log(String msg, long p1, float p2)
public final void log(String msg, long p1, int p2)
public final void log(String msg, long p1, @Nullable() Object p2)
public final void log(String msg, long p1, long p2)
public final void log(String msg, long p1, short p2)
public final void log(String msg, short p1, boolean p2)
public final void log(String msg, short p1, byte p2)
public final void log(String msg, short p1, char p2)
public final void log(String msg, short p1, double p2)
public final void log(String msg, short p1, float p2)
public final void log(String msg, short p1, int p2)
public final void log(String msg, short p1, @Nullable() Object p2)
public final void log(String msg, short p1, long p2)
public final void log(String msg, short p1, short p2)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6, @Nullable() Object p7)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6, @Nullable() Object p7, @Nullable() Object p8)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6, @Nullable() Object p7, @Nullable() Object p8, @Nullable() Object p9)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6, @Nullable() Object p7, @Nullable() Object p8, @Nullable() Object p9, @Nullable() Object p10)
public final void log(String msg, @Nullable() Object p1, @Nullable() Object p2, @Nullable() Object p3, @Nullable() Object p4, @Nullable() Object p5, @Nullable() Object p6, @Nullable() Object p7, @Nullable() Object p8, @Nullable() Object p9, @Nullable() Object p10, Array<Object> rest)
Logs a message with formatted arguments (see log for details).
public final void log(String msg, @Nullable() Object p1)
Logs a formatted representation of the given parameter, using the specified message template.
Link copied to clipboard
public final void logVarargs(String msg, Array<Object> params)
Logs a formatted representation of values in the given array, using the specified message template.
Link copied to clipboard
protected final API noOp()
Link copied to clipboard
public final API onAverageEvery(int n)
Modifies the current log statement to be emitted with likelihood 1 in n.
Link copied to clipboard
public API per(LoggingScopeProvider scopeProvider)
Aggregates stateful logging with respect to a scoped context determined by the given scope provider.
public API per(@Nullable() @Nullable() Enum<? extends Object> key)
Aggregates stateful logging with respect to the given enum value.
public API per<T>(@Nullable() @Nullable() T key, LogPerBucketingStrategy<? extends Object> strategy)
Aggregates stateful logging with respect to a given key.
Link copied to clipboard
public final API with(FloggerMetadataKey<Boolean> key)
Sets a boolean metadata key constant to true for this log statement in a structured way that is accessible to logger backends.
public final API with<T>(FloggerMetadataKey<T> key, @Nullable() @Nullable() T value)
Associates a metadata key constant with a runtime value for this log statement in a structured way that is accessible to logger backends.
Link copied to clipboard
public final API withCause(@Nullable() @Nullable() Throwable cause)
Associates a Throwable instance with the current log statement, to be interpreted as the cause of this statement.
Link copied to clipboard
public API withInjectedLogSite(FloggerLogSite logSite)
Sets the log site for the current log statement.
public API withInjectedLogSite(String internalClassName, String methodName, int encodedLineNumber, @Nullable() @Nullable() String sourceFileName)
Internal method not for public use.
Link copied to clipboard
public API withStackTrace(StackSize size)
Creates a synthetic exception and attaches it as the "cause" of the log statement as a way to provide additional context for the logging call itself.