Package aQute.service.reporter

Interface Reporter

All Superinterfaces:

Report

All Known Implementing Classes:

AbstractConsoleApp, Env, LogToReporterAdapter, ReplacerAdapter, ReporterAdapter, Slf4jReporter

public interface Reporter
extends Report

A base interface to model a work in progress. Though exceptions work well for major, well, exceptions, they are lousy for reporting errors/warnings in a task. Logging also sucks because it is global, hard to relate to a single piece of work. This small (uncoupled) interface is intended to fill this gap. The idea is that different tasks can perform parts and the progress can be integrated. A reporter is not mandated to track locations. Locations should be seen as best effort.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Reporter.SetLocation	Fluid interface to set location data

Nested classes/interfaces inherited from interface aQute.service.reporter.Report

Report.Location

Method Summary

Modifier and Type	Method	Description
Reporter.SetLocation	error(java.lang.String format, java.lang.Object... args)	Create an error.
Reporter.SetLocation	exception(java.lang.Throwable t, java.lang.String format, java.lang.Object... args)	Dedicated message for an exception.
boolean	isPedantic()	The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.
void	progress(float progress, java.lang.String format, java.lang.Object... args)	Deprecated. Use SLF4J Logger.info(aQute.libg.slf4j.GradleLogging.LIFECYCLE) instead.
void	trace(java.lang.String format, java.lang.Object... args)	Deprecated. Use SLF4J Logger.debug instead.
Reporter.SetLocation	warning(java.lang.String format, java.lang.Object... args)	Create a warning.

Methods inherited from interface aQute.service.reporter.Report

getErrors, getLocation, getWarnings, isOk

Method Detail

error

Reporter.SetLocation error(java.lang.String format,
                           java.lang.Object... args)

Create an error. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Parameters:

format - The format of the error

args - The arguments of the error

Returns:

a SetLocation to set the location

warning

Reporter.SetLocation warning(java.lang.String format,
                             java.lang.Object... args)

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Parameters:

format - The format of the error

args - The arguments of the error

Returns:

a SetLocation to set the location

trace

@Deprecated
void trace(java.lang.String format,
           java.lang.Object... args)

Deprecated.

Use SLF4J Logger.debug instead.

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Parameters:

format - The format of the error

args - The arguments of the error

progress

@Deprecated
void progress(float progress,
              java.lang.String format,
              java.lang.Object... args)

Deprecated.

Use SLF4J Logger.info(aQute.libg.slf4j.GradleLogging.LIFECYCLE) instead.

Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.

Parameters:

progress - A value between 0 and 1 indicating the progress. 0 is starting and >=1 is done.

format - The format of the error

args - The arguments of the error

exception

Reporter.SetLocation exception(java.lang.Throwable t,
                               java.lang.String format,
                               java.lang.Object... args)

Dedicated message for an exception.

Parameters:

t - The exception

format - The format of the message

args - The arguments

isPedantic

boolean isPedantic()

The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.

Returns:

if this is a pedantic reporter.