Package aQute.service.reporter
Interface Reporter
- All Superinterfaces:
Report
- All Known Implementing Classes:
AbstractConsoleApp
,Analyzer
,BaseTask
,BasicAuthentication
,BearerAuthentication
,bnd
,BndAuthentication
,BndTask
,BuildContext
,Builder
,CommunicationCommands
,ConnectionSettings
,DefaultURLConnectionHandler
,DeployTask
,EclipseCommand
,EclipseTask
,Env
,ExpandPropertiesTask
,HeaderReader
,HttpsVerification
,IndexCommand
,JarPrinter
,JUnitFramework.BundleBuilder
,JUnitLauncher
,LogToReporterAdapter
,Makefile
,MavenCommand
,MavenDeployCmd
,PackageTask
,PomParser
,PrepareTask
,Processor
,Profiles
,Project
,ProjectBuilder
,ProjectBuildOrderTask
,ProjectLauncher
,ProjectTask
,ReleaseTask
,ReplacerAdapter
,ReporterAdapter
,Run
,RunBundlesTask
,RunconfigToDistributionTask
,ServiceComponent.ComponentMaker
,Signer
,Slf4jReporter
,TestTask
,Verifier
,Workspace
,WrapTask
,XMLResourceParser
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 ClassesModifier and TypeInterfaceDescriptionstatic interface
Fluid interface to set location dataNested classes/interfaces inherited from interface aQute.service.reporter.Report
Report.Location
-
Method Summary
Modifier and TypeMethodDescriptionCreate an error.Dedicated message for an exception.boolean
The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.void
Deprecated.Use SLF4J Logger.info(aQute.libg.slf4j.GradleLogging.LIFECYCLE) instead.void
Create a warning.Create a warning.Methods inherited from interface aQute.service.reporter.Report
getErrors, getLocation, getWarnings, isOk
-
Method Details
-
error
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 errorargs
- The arguments of the error- Returns:
- a SetLocation to set the location
-
warning
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 errorargs
- The arguments of the error- Returns:
- a SetLocation to set the location
-
trace
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 errorargs
- The arguments of the error
-
progress
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 errorargs
- The arguments of the error
-
exception
Dedicated message for an exception.- Parameters:
t
- The exceptionformat
- The format of the messageargs
- 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.
-