bndtools.release.api.ReleaseContext Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bndtools.release Show documentation
bndtools.release
The newest version!
package bndtools.release.api;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import org.eclipse.core.runtime.IProgressMonitor;

import aQute.bnd.build.Project;
import aQute.bnd.differ.Baseline;
import aQute.bnd.osgi.Jar;
import aQute.bnd.service.RepositoryPlugin;
import bndtools.release.api.IReleaseParticipant.Scope;

public class ReleaseContext {

	private final Project				project;
	private final List		diffs;
	private final RepositoryPlugin		releaseRepo;
	private IProgressMonitor			progressMonitor;

	private final List				releasedJars;
	private final List			releasedJarSummaries;
	private final Map	properties;
	private final ErrorHandler			errorHandler;
	private Scope						currentScope;
	private ReleaseOption				releaseOption;

	public ReleaseContext(Project project, List diffs, RepositoryPlugin releaseRepo,
		ReleaseOption releaseOption) {
		this.project = project;
		this.diffs = diffs;
		this.releaseRepo = releaseRepo;
		this.releaseOption = releaseOption;

		this.releasedJars = new ArrayList<>();
		this.releasedJarSummaries = new ArrayList<>();
		this.properties = new HashMap<>();
		this.errorHandler = new ErrorHandler();
	}

	@Deprecated
	public ReleaseContext(Project project, List diffs, RepositoryPlugin releaseRepo, boolean updateOnly) {
		this(project, diffs, releaseRepo, updateOnly ? ReleaseOption.UPDATE : ReleaseOption.UPDATE_RELEASE);
	}

	public Project getProject() {
		return project;
	}

	public List getBaselines() {
		return diffs;
	}

	public RepositoryPlugin getReleaseRepository() {
		return releaseRepo;
	}

	public IProgressMonitor getProgressMonitor() {
		return progressMonitor;
	}

	public void setProgressMonitor(IProgressMonitor progressMonitor) {
		this.progressMonitor = progressMonitor;
	}

	public void addReleasedJar(Jar jar) {
		releasedJars.add(jar);

		// Save off our summary info now, because our JARs will get
		// closed out from underneath us later
		releasedJarSummaries.add(ReleaseUtils.getBundleSymbolicName(jar) + "-" + ReleaseUtils.getBundleVersion(jar));
	}

	public List getReleasedJars() {
		return releasedJars;
	}

	public List getReleaseSummaries() {
		return releasedJarSummaries;
	}

	public void close() {
		// the released jars were closed by the project builder
	}

	public void setProperty(String name, Object value) {
		properties.put(name, value);
	}

	public Object getProperty(String name) {
		return properties.get(name);
	}

	public Map getPropertyMap() {
		return properties;
	}

	public Scope getCurrentScope() {
		return currentScope;
	}

	public void setCurrentScope(Scope currentScope) {
		this.currentScope = currentScope;
	}

	public ErrorHandler getErrorHandler() {
		return errorHandler;
	}

	public class ErrorHandler {

		private List errors = new LinkedList<>();

		protected ErrorHandler() {
			super();
		}

		public void error(String message) {
			Error error = new Error();
			error.scope = getCurrentScope();
			error.message = message;
			errors.add(error);
		}

		public Error error(String symbName, String version, String message) {
			Error error = new Error();
			error.scope = getCurrentScope();
			error.message = message;
			error.symbName = symbName;
			error.version = version;
			errors.add(error);
			return error;
		}

		public Error error(String symbName, String version, String message, String[][] list, String... headers) {
			Error error = error(symbName, version, message);
			error.list = list;
			error.headers = headers;
			return error;
		}

		public List getErrors() {
			return errors;
		}

		public void clear() {
			errors = new ArrayList<>();
		}
	}

	/**
	 * @deprecated Use getReleaseOption instead
	 * @return true if the release option is UPDATE
	 */
	@Deprecated
	public boolean isUpdateOnly() {
		return releaseOption == ReleaseOption.UPDATE;
	}

	/**
	 * @deprecated Use setReleaseOption instead
	 * @param updateOnly true to indicate 'update only mode'
	 */
	@Deprecated
	public void setUpdateOnly(boolean updateOnly) {
		this.releaseOption = updateOnly ? ReleaseOption.UPDATE : ReleaseOption.UPDATE_RELEASE;
	}

	public void setReleaseOption(ReleaseOption releaseOption) {
		this.releaseOption = releaseOption;
	}

	public ReleaseOption getReleaseOption() {
		return releaseOption;
	}

	public static class Error {

		protected Scope			scope;
		protected String		message;
		protected String		symbName;
		protected String		version;
		protected String[][]	list;
		protected String[]		headers;

		public Scope getScope() {
			return scope;
		}

		public String getMessage() {
			return message;
		}

		public String getSymbName() {
			return symbName;
		}

		public String getVersion() {
			return version;
		}

		public String[][] getList() {
			return list;
		}

		public String[] getHeaders() {
			return headers;
		}
	}
}