flogger-api/com.google.common.flogger.backend/Platform

Platform

public abstract class Platform

Platform abstraction layer required to allow fluent logger implementations to work on differing Java platforms (such as Android or GWT). The Platform class is responsible for providing any platform specific APIs, including the mechanism by which logging backends are created.

To enable an additional logging platform implementation, the class name should be added to the list of available platforms before the default platform (which must always be at the end). Platform implementation classes must subclass Platform and have a public, no-argument constructor. Platform instances are created on first-use of a fluent logger and platform implementors must take care to avoid cycles during initialization and re-entrant behaviour.

Constructors

public void Platform()

Types

LogCallerFinder

public abstract class LogCallerFinder

API for determining the logging class and log statement sites, return from getCallerFinder.

Functions

public static LoggerBackend getBackend(String className)

Returns a logger backend of the given class name for use by a Fluent Logger.

protected abstract LoggerBackend getBackendImpl(String className)

getCallerFinder

public static Platform.LogCallerFinder getCallerFinder()

Returns the API for obtaining caller information about loggers and logging classes.

getCallerFinderImpl

protected abstract Platform.LogCallerFinder getCallerFinderImpl()

public static String getConfigInfo()

Returns a human readable string describing the platform and its configuration.

getConfigInfoImpl

protected abstract String getConfigInfoImpl()

getContextDataProvider

public static ContextDataProvider getContextDataProvider()

Returns the singleton ContextDataProvider from which a ScopedLoggingContext can be obtained.

getContextDataProviderImpl

protected ContextDataProvider getContextDataProviderImpl()

getCurrentRecursionDepth

public static int getCurrentRecursionDepth()

Returns the current depth of recursion for logging in the current thread.

getCurrentTimeNanos

public static long getCurrentTimeNanos()

Returns the current time from the epoch (00:00 1st Jan, 1970) with nanosecond granularity.

getCurrentTimeNanosImpl

protected long getCurrentTimeNanosImpl()

getInjectedMetadata

public static Metadata getInjectedMetadata()

Returns Metadata from with the current context to be injected into log statements.

getInjectedTags

public static Tags getInjectedTags()

Returns Tags from with the current context to be injected into log statements.

shouldForceLogging

public static boolean shouldForceLogging(String loggerName, Level level, boolean isEnabled)

Returns whether the given logger should have logging forced at the specified level.