Package aQute.service.reporter
Interface Report
-
- All Known Subinterfaces:
Reporter
- All Known Implementing Classes:
AbstractConsoleApp
,Env
,LogToReporterAdapter
,ReplacerAdapter
,ReporterAdapter
,Slf4jReporter
public interface Report
A base interface to represent the state of a work in progress.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
Report.Location
Defines a record for the location of an error/warning
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.util.List<java.lang.String>
getErrors()
Return the errors.Report.Location
getLocation(java.lang.String msg)
Return the errors for the given error or warning.java.util.List<java.lang.String>
getWarnings()
Return the warnings.boolean
isOk()
Check if this report has any relevant errors that should make the run associated with this report invalid.
-
-
-
Method Detail
-
getWarnings
java.util.List<java.lang.String> getWarnings()
Return the warnings. This list must not be changed and may be immutable.- Returns:
- the warnings
-
getErrors
java.util.List<java.lang.String> getErrors()
Return the errors. This list must not be changed and may be immutable.- Returns:
- the errors
-
getLocation
Report.Location getLocation(java.lang.String msg)
Return the errors for the given error or warning. Can return null.- Parameters:
msg
- The message- Returns:
- null or the location of the message
-
isOk
boolean isOk()
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.- Returns:
- true if this run should be disregarded due to errors
-
-