com.asakusafw.runtime.core.legacy

Class LegacyReport

java.lang.Object

com.asakusafw.runtime.core.legacy.LegacyReport

public final class LegacyReport
extends Object

A legacy implementation of Report API entry class.

Since:

0.9.0

See Also:

Report

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LegacyReport.Initializer An initializer for Report.Delegate.

Field Summary

Fields

Modifier and Type	Field and Description
static ReportApi	API The API of this implementation.

Method Summary

Modifier and Type	Method and Description
static void	error(String message) Reports an error message.
static void	error(String message, Throwable throwable) Reports an error message.
static void	info(String message) Reports an informative message.
static void	info(String message, Throwable throwable) Reports an informative message.
static void	setDelegate(Report.Delegate delegate) Sets a custom implementation for the current thread.
static void	warn(String message) Reports a warning message.
static void	warn(String message, Throwable throwable) Reports a warning message.

Methods inherited from class java.lang.Object

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

Field Detail

API

public static final ReportApi API

The API of this implementation.

Method Detail

setDelegate

public static void setDelegate(Report.Delegate delegate)

Sets a custom implementation for the current thread. After the implementation was set, each report API method will be redirected to the implementation. Application developers should not use this method directly.

Parameters:

delegate - the custom implementation, or null to unregister the implementation

info

public static void info(String message)

Reports an informative message. Clients should put @Sticky annotation to the operator method that using this.

Parameters:

message - the message

Throws:

Report.FailedException - if error was occurred while reporting the message

info

public static void info(String message,
                        Throwable throwable)

Reports an informative message. Clients should put @Sticky annotation to the operator method that using this.

Parameters:

message - the message

throwable - the optional exception object (nullable)

Throws:

Report.FailedException - if error was occurred while reporting the message

warn

public static void warn(String message)

Reports a warning message. Clients should put @Sticky annotation to the operator method that using this.

Parameters:

message - the message

Throws:

Report.FailedException - if error was occurred while reporting the message

warn

public static void warn(String message,
                        Throwable throwable)

Reports a warning message. Clients should put @Sticky annotation to the operator method that using this.

Parameters:

message - the message

throwable - the optional exception object (nullable)

Throws:

Report.FailedException - if error was occurred while reporting the message

error

public static void error(String message)

Reports an error message. Clients should put @Sticky annotation to the operator method that using this. Please be careful that this method will NOT shutdown the running batch. To shutdown the batch, throw an exception (RuntimeException) in operator methods.

Parameters:

message - the message

Throws:

Report.FailedException - if error was occurred while reporting the message

error

public static void error(String message,
                         Throwable throwable)

Reports an error message. Clients should put @Sticky annotation to the operator method that using this. Please be careful that this method will NOT shutdown the running batch. To shutdown the batch, throw an exception (RuntimeException) in operator methods.

Parameters:

message - the message

throwable - the optional exception object (nullable)

Throws:

Report.FailedException - if error was occurred while reporting the message