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, ProjectBuilder.ArtifactInfoImpl, ProjectBuilder.BuildInfoImpl, ProjectBuildOrderTask, ProjectLauncher, ProjectTask, ReleaseTask, ReplacerAdapter, ReporterAdapter, Run, RunBundlesTask, RunconfigToDistributionTask, ServiceComponent.ComponentMaker, Signer, Slf4jReporter, TestTask, ToolManager, Verifier, Workspace, WrapTask, XmlRepoDiffCommand, XMLResourceParser
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.

  • Method Details

    • error

      Reporter.SetLocation error(String format, 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(String format, 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

      void trace(String format, 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

    • progress

      @Deprecated void progress(float progress, String format, 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(Throwable t, String format, 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.