com.facebook.spectrum.logging

Class BaseSpectrumLogger

java.lang.Object

com.facebook.spectrum.logging.BaseSpectrumLogger

All Implemented Interfaces:

SpectrumLogger

Direct Known Subclasses:

SpectrumLogcatLogger

public class BaseSpectrumLogger
extends java.lang.Object
implements SpectrumLogger

Logger implementation that performs no operations

Constructor Summary

Constructors

Constructor and Description
BaseSpectrumLogger()

Method Summary

Modifier and Type	Method and Description
void	onError(java.lang.Object loggingContext, java.lang.Exception exception) Called for any exception that occurs during the operation.
void	onFinish(java.lang.Object loggingContext, SpectrumResult result) Called when the operation finishes.
java.lang.Object	onStart(Options options, java.lang.Object callerContext) Called before the operation is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseSpectrumLogger

public BaseSpectrumLogger()

Method Detail

onStart

@Nullable
public java.lang.Object onStart(Options options,
                                          java.lang.Object callerContext)

Description copied from interface: SpectrumLogger

Called before the operation is started.

Specified by:

onStart in interface SpectrumLogger

Parameters:

options - The given Options for the operation

callerContext - An integration specific object that provides information about the calling site

Returns:

A logging context that will be returned to this class when the SpectrumLogger.onFinish(java.lang.Object, com.facebook.spectrum.SpectrumResult) and SpectrumLogger.onError(java.lang.Object, java.lang.Exception) methods are called. This can be used to differentiate operations. Can be null.

onError

public void onError(@Nullable
                    java.lang.Object loggingContext,
                    java.lang.Exception exception)

Description copied from interface: SpectrumLogger

Called for any exception that occurs during the operation.

Specified by:

onError in interface SpectrumLogger

Parameters:

loggingContext - The logging context that was returned initially by the SpectrumLogger.onStart(com.facebook.spectrum.options.Options, java.lang.Object) method (if any).

exception - The exception that was thrown

onFinish

public void onFinish(@Nullable
                     java.lang.Object loggingContext,
                     @Nullable
                     SpectrumResult result)

Description copied from interface: SpectrumLogger

Called when the operation finishes. This method is guaranteed to be called exactly once and no other callback is called afterwards for a given operation.

Specified by:

onFinish in interface SpectrumLogger

Parameters:

loggingContext - The logging context that was returned initially by the SpectrumLogger.onStart(com.facebook.spectrum.options.Options, java.lang.Object) method (if any).

result - The SpectrumResult returned by the operation