org.eclipse.tycho.versions.engine.ImportRefVersionConstraint Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of tycho-versions-plugin Show documentation
There is a newer version: 3.0.5
Show newest version
/*******************************************************************************
 * Copyright (c) 2015 Sebastien Arod and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    Sebastien Arod - Initial implementation
 *******************************************************************************/
package org.eclipse.tycho.versions.engine;

import java.util.Objects;

import org.osgi.framework.Version;

/**
 * Represent a version constraint using version and match attributes as defined
 * in feature manifest file (feature>requires>import)
 * {@link https://help.eclipse.org/mars/index.jsp?topic=%2Forg.eclipse.platform.doc.isv%2Freference%2Fmisc%2Ffeature_manifest.html&cp=2_1_5_20}
 * 
 * @author sarod
 *
 */
public class ImportRefVersionConstraint {

	public static final String MATCH_GREATER_OR_EQUAL = "greaterOrEqual";
	public static final String MATCH_COMPATIBLE = "compatible";
	public static final String MATCH_EQUIVALENT = "equivalent";
	public static final String MATCH_PERFECT = "perfect";
	private final String version;
	private final String match;

	public ImportRefVersionConstraint(String version, String match) {
		this.version = version;
		this.match = match;
	}

	public String getVersion() {
		return version;
	}

	public String getMatch() {
		return match;
	}

	public ImportRefVersionConstraint withVersion(String newVersion) {
		return new ImportRefVersionConstraint(newVersion, getMatch());
	}

	/**
	 * Test whether otherVersion matches the current constraint.
	 * 
	 * @return true if otherVersion matches the constraint.
	 */
	public boolean matches(String otherVersion) {
		if (version == null) {
			return true;
		}
		Version parsedLocalVersion = Version.parseVersion(version);
		Version parsedOtherVersion = Version.parseVersion(otherVersion);
		if (match == null) {
			return isCompatible(parsedLocalVersion, parsedOtherVersion);
		} else {
			switch (match) {
			case MATCH_PERFECT:
				return isPerfectMatch(parsedLocalVersion, parsedOtherVersion);
			case MATCH_EQUIVALENT:
				return isEquivalent(parsedLocalVersion, parsedOtherVersion);
			case MATCH_COMPATIBLE:
				return isCompatible(parsedLocalVersion, parsedOtherVersion);
			case MATCH_GREATER_OR_EQUAL:
				return isGreaterOrEqual(parsedLocalVersion, parsedOtherVersion);
			default:
				return isCompatible(parsedLocalVersion, parsedOtherVersion);
			}
		}
	}

	private boolean isPerfectMatch(Version parsedLocalVersion, Version parsedOtherVersion) {
		return parsedLocalVersion.compareTo(parsedOtherVersion) == 0;
	}

	private boolean isEquivalent(Version parsedLocalVersion, Version parsedOtherVersion) {
		return isGreaterOrEqual(parsedLocalVersion, parsedOtherVersion)
				&& parsedLocalVersion.getMajor() == parsedOtherVersion.getMajor()
				&& parsedLocalVersion.getMinor() == parsedOtherVersion.getMinor();
	}

	private boolean isCompatible(Version parsedLocalVersion, Version parsedOtherVersion) {
		return isGreaterOrEqual(parsedLocalVersion, parsedOtherVersion)
				&& parsedLocalVersion.getMajor() == parsedOtherVersion.getMajor();
	}

	private boolean isGreaterOrEqual(Version parsedLocalVersion, Version parsedOtherVersion) {
		return parsedLocalVersion.compareTo(parsedOtherVersion) <= 0;
	}

	@Override
	public int hashCode() {
		return Objects.hash(version, match);
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;
		ImportRefVersionConstraint other = (ImportRefVersionConstraint) obj;
		return Objects.equals(version, other.version) && Objects.equals(match, other.match);
	}

	@Override
	public String toString() {
		if (version == null) {
			return "";
		} else {
			return version + "(match=" + match + ")";
		}
	}
}