aQute.bnd.version.Version Maven / Gradle / Ivy

Go to download
package aQute.bnd.version;

import java.util.Comparator;
import java.util.Objects;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import aQute.lib.regex.PatternConstants;

public class Version implements Comparable {
	private static final String				HIGHESTCHAR			= "\uFFFF";
	final int								major;
	final int								minor;
	final int								micro;
	final String							qualifier;
	final boolean							snapshot;

	public final static String				VERSION_STRING		= "(\\d{1,10})(\\.(\\d{1,10})(\\.(\\d{1,10})(\\.("
		+ PatternConstants.TOKEN + "))?)?)?";
	public final static Pattern				VERSION				= Pattern.compile(VERSION_STRING);
	public final static Version				LOWEST				= new Version();
	public final static Version				HIGHEST				= new Version(Integer.MAX_VALUE, Integer.MAX_VALUE,
		Integer.MAX_VALUE, HIGHESTCHAR);

	public static final Version				emptyVersion		= LOWEST;
	public static final Version				ONE					= new Version(1, 0, 0);
	public static final Pattern				SNAPSHOT_P			= Pattern.compile("(.*-)?SNAPSHOT$");

	private static final Comparator	qualifierComparator	= Comparator.nullsFirst(Comparator.naturalOrder());

	public Version() {
		this(0);
	}

	public Version(int major, int minor, int micro, String qualifier) {
		this.major = major;
		this.minor = minor;
		this.micro = micro;
		this.qualifier = ((qualifier != null) && qualifier.isEmpty()) ? null : qualifier;
		this.snapshot = isSnapshot(this.qualifier);
	}

	public Version(int major, int minor, int micro) {
		this(major, minor, micro, null);
	}

	public Version(int major, int minor) {
		this(major, minor, 0, null);
	}

	public Version(int major) {
		this(major, 0, 0, null);
	}

	public Version(String version) {
		version = version.trim();
		Matcher m = VERSION.matcher(version);
		if (!m.matches())
			throw new IllegalArgumentException("Invalid syntax for version: " + version);

		major = Integer.parseInt(m.group(1));
		if (m.group(3) != null)
			minor = Integer.parseInt(m.group(3));
		else
			minor = 0;

		if (m.group(5) != null)
			micro = Integer.parseInt(m.group(5));
		else
			micro = 0;

		qualifier = m.group(7);
		this.snapshot = isSnapshot(qualifier);
	}

	public Version(org.osgi.framework.Version v) {
		this(v.getMajor(), v.getMinor(), v.getMicro(), v.getQualifier());
	}

	private boolean isSnapshot(String qualifier) {
		return qualifier != null && qualifier != HIGHESTCHAR && SNAPSHOT_P.matcher(qualifier)
			.matches();
	}

	public int getMajor() {
		return major;
	}

	public int getMinor() {
		return minor;
	}

	public int getMicro() {
		return micro;
	}

	public String getQualifier() {
		return qualifier;
	}

	@Override
	public int compareTo(Version other) {
		if (other == this)
			return 0;

		int cmp = Integer.compare(major, other.major);
		if (cmp != 0)
			return cmp;

		cmp = Integer.compare(minor, other.minor);
		if (cmp != 0)
			return cmp;

		cmp = Integer.compare(micro, other.micro);
		if (cmp != 0)
			return cmp;

		return Objects.compare(qualifier, other.qualifier, qualifierComparator);
	}

	@Override
	public String toString() {
		StringBuilder sb = new StringBuilder();
		sb.append(major)
			.append('.')
			.append(minor)
			.append('.')
			.append(micro);
		if (qualifier != null) {
			sb.append('.')
				.append(qualifier);
		}
		return sb.toString();
	}

	String toMavenString() {
		StringBuilder sb = new StringBuilder();
		sb.append(major)
			.append('.')
			.append(minor)
			.append('.')
			.append(micro);
		if (qualifier != null) {
			sb.append('-')
				.append(qualifier);
		}
		return sb.toString();
	}

	public String toStringWithoutQualifier() {
		StringBuilder sb = new StringBuilder();
		sb.append(major)
			.append('.')
			.append(minor)
			.append('.')
			.append(micro);
		return sb.toString();
	}

	@Override
	public boolean equals(Object ot) {
		if (!(ot instanceof Version other))
			return false;

		return compareTo(other) == 0;
	}

	@Override
	public int hashCode() {
		return major * 97 ^ minor * 13 ^ micro + (qualifier == null ? 97 : qualifier.hashCode());
	}

	public int get(int i) {
		return switch (i) {
			case 0 -> major;
			case 1 -> minor;
			case 2 -> micro;
			default -> throw new IllegalArgumentException("Version can only get 0 (major), 1 (minor), or 2 (micro)");
		};
	}

	public static Version parseVersion(String version) {
		if (version == null) {
			return LOWEST;
		}

		return valueOf(version);
	}

	public static Version valueOf(String version) {
		version = version.trim();
		if (version.isEmpty()) {
			return LOWEST;
		}

		return new Version(version);
	}

	public Version getWithoutQualifier() {
		if (qualifier == null) {
			return this;
		}
		return new Version(major, minor, micro);
	}

	public static boolean isVersion(String version) {
		return (version != null) && VERSION.matcher(version)
			.matches();
	}

	public boolean isSnapshot() {
		return snapshot;
	}

	public Version bumpMajor() {
		return new Version(major + 1);
	}

	public Version bumpMinor() {
		return new Version(major, minor + 1);
	}
}