Class ReporterAdapter

java.lang.Object
aQute.libg.reporter.ReporterAdapter
All Implemented Interfaces:
Report, Reporter, Runnable
Direct Known Subclasses:
Env, LogToReporterAdapter, ReplacerAdapter, Slf4jReporter
public class ReporterAdapter extends Object implements Reporter, Report, Runnable
Mainly used for testing where reporters are needed.

  • Constructor Details

    • ReporterAdapter

      public ReporterAdapter()

    • ReporterAdapter

      public ReporterAdapter(Appendable app)

  • Method Details

    • isExceptions

      public boolean isExceptions()
      Returns:
      the exceptions

    • setExceptions

      public void setExceptions(boolean exceptions)
      Parameters:
      exceptions - the exceptions to set

    • getOut

      public Formatter getOut()
      Returns:
      the out

    • isTrace

      public boolean isTrace()
      Returns:
      the trace

    • setPedantic

      public void setPedantic(boolean pedantic)
      Parameters:
      pedantic - the pedantic to set

    • error

      public Reporter.SetLocation error(String s, Object... args)
      Description copied from interface: Reporter
      Create an error. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.
      Specified by:
      error in interface Reporter
      Parameters:
      s - The format of the error
      args - The arguments of the error
      Returns:
      a SetLocation to set the location

    • exception

      public Reporter.SetLocation exception(Throwable t, String s, Object... args)
      Description copied from interface: Reporter
      Dedicated message for an exception.
      Specified by:
      exception in interface Reporter
      Parameters:
      t - The exception
      s - The format of the message
      args - The arguments

    • warning

      public Reporter.SetLocation warning(String s, Object... args)
      Description copied from interface: Reporter
      Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.
      Specified by:
      warning in interface Reporter
      Parameters:
      s - The format of the error
      args - The arguments of the error
      Returns:
      a SetLocation to set the location

    • progress

      @Deprecated public void progress(float progress, String s, Object... args)
      Deprecated.
      Use SLF4J Logger.info(aQute.libg.slf4j.GradleLogging.LIFECYCLE) instead.
      Description copied from interface: Reporter
      Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.
      Specified by:
      progress in interface Reporter
      Parameters:
      progress - A value between 0 and 1 indicating the progress. 0 is starting and >=1 is done.
      s - The format of the error
      args - The arguments of the error

    • trace

      public void trace(String s, Object... args)
      Description copied from interface: Reporter
      Create a warning. Implementations must ensure that the given args are not prevented from garbage collecting. The args must have a proper toString method.
      Specified by:
      trace in interface Reporter
      Parameters:
      s - The format of the error
      args - The arguments of the error

    • getWarnings

      public List<String> getWarnings()
      Description copied from interface: Report
      Return the warnings. This list must not be changed and may be immutable.
      Specified by:
      getWarnings in interface Report
      Returns:
      the warnings

    • getErrors

      public List<String> getErrors()
      Description copied from interface: Report
      Return the errors. This list must not be changed and may be immutable.
      Specified by:
      getErrors in interface Report
      Returns:
      the errors

    • isPedantic

      public boolean isPedantic()
      Description copied from interface: Reporter
      The provider of the reporter wants pedantic reporting, meaning every possible warning should be reported.
      Specified by:
      isPedantic in interface Reporter
      Returns:
      if this is a pedantic reporter.

    • setTrace

      public void setTrace(boolean b)

    • isOk

      public boolean isOk()
      Description copied from interface: Report
      Check if this report has any relevant errors that should make the run associated with this report invalid. I.e. if this returns false then the run should be disregarded.
      Specified by:
      isOk in interface Report
      Returns:
      true if this run should be disregarded due to errors

    • isPerfect

      public boolean isPerfect()

    • check

      public boolean check(String... pattern)

    • report

      public void report(Appendable out)
      Report the errors and warnings

    • getInfo

      public boolean getInfo(Report other)

    • getInfo

      public boolean getInfo(Report other, String prefix)

    • getLocation

      public Report.Location getLocation(String msg)
      Description copied from interface: Report
      Return the errors for the given error or warning. Can return null.
      Specified by:
      getLocation in interface Report
      Parameters:
      msg - The message
      Returns:
      null or the location of the message

    • run

      public void run()
      Handy routine that can be extended by subclasses so they can run inside the context
      Specified by:
      run in interface Runnable

    • getMessages

      public <T> T getMessages(Class<T> c)
      Return a messages object bound to this adapter

    • addErrors

      public void addErrors(String prefix, Collection<String> errors)
      Add a number of errors

    • addWarnings

      public void addWarnings(String prefix, Collection<String> warnings)
      Add a number of warnings