aQute.service.reporter.Report Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of biz.aQute.to Show documentation

biz.aQute.to

There is a newer version: 1.2.0

package aQute.service.reporter;

import java.util.List;

/**
 * A base interface to represent the state of a work in progress.
 */
public interface Report {
	/**
	 * Defines a record for the location of an error/warning
	 */
	class Location {
		public String	message;
		public int		line;
		public String	file;
		public String	header;
		public String	context;
		public String	reference;
		public String	methodName;
		/**
		 * @see Reporter.SetLocation#details(Object)
		 */
		public Object	details;
		public int		length;
	}

	/**
	 * Return the warnings. This list must not be changed and may be immutable.
	 *
	 * @return the warnings
	 */
	List getWarnings();

	/**
	 * Return the errors. This list must not be changed and may be immutable.
	 *
	 * @return the errors
	 */
	List getErrors();

	/**
	 * Return the errors for the given error or warning. Can return null.
	 *
	 * @param msg The message
	 * @return null or the location of the message
	 */
	Location getLocation(String msg);

	/**
	 * 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.
	 *
	 * @return true if this run should be disregarded due to errors
	 */

	boolean isOk();
}