dev.jbang.dependencies.MavenCoordinate Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jbang-cli Show documentation
JBang Command Line Interface
There is a newer version: 0.121.0
package dev.jbang.dependencies;

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

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class MavenCoordinate {
	private final String groupId;
	private final String artifactId;
	private final String version;
	private final String classifier;
	private final String type;

	public static final String DUMMY_GROUP = "group";
	public static final String DEFAULT_VERSION = "999-SNAPSHOT";

	private static final Pattern gavPattern = Pattern.compile(
			"^(?[^:]*):(?[^:]*)(:(?[^:@]*))?(:(?[^@]*))?(@(?.*))?$");

	private static final Pattern canonicalPattern = Pattern.compile(
			"^(?[^:]*):(?[^:]*)((:(?.*)(:(?[^@]*))?)?:(?[^:@]*))?$");

	public String getGroupId() {
		return groupId;
	}

	public String getArtifactId() {
		return artifactId;
	}

	public String getVersion() {
		return version;
	}

	public String getClassifier() {
		return classifier;
	}

	public String getType() {
		return type;
	}

	public static MavenCoordinate fromString(String depId) {
		return parse(depId, gavPattern);
	}

	public static MavenCoordinate fromCanonicalString(String depId) {
		return parse(depId, canonicalPattern);
	}

	private static MavenCoordinate parse(String depId, Pattern pattern) {
		Matcher gav = pattern.matcher(depId);
		gav.find();

		if (!gav.matches()) {
			throw new IllegalStateException(String.format(
					"[ERROR] Invalid dependency locator: '%s'.  Expected format is groupId:artifactId:version[:classifier][@type]",
					depId));
		}

		String groupId = gav.group("groupid");
		String artifactId = gav.group("artifactid");
		String version = DependencyUtil.formatVersion(gav.group("version"));
		String classifier = gav.group("classifier");
		String type = Optional.ofNullable(gav.group("type")).orElse("jar");

		return new MavenCoordinate(groupId, artifactId, version, classifier, type);
	}

	public MavenCoordinate(@Nonnull String groupId, @Nonnull String artifactId, @Nonnull String version) {
		this(groupId, artifactId, version, null, null);
	}

	public MavenCoordinate(@Nonnull String groupId, @Nonnull String artifactId, @Nonnull String version,
			@Nullable String classifier, @Nullable String type) {
		this.groupId = groupId;
		this.artifactId = artifactId;
		this.version = version;
		this.classifier = classifier != null && classifier.isEmpty() ? null : classifier;
		this.type = type;
	}

	public MavenCoordinate withVersion() {
		return version != null ? this
				: new MavenCoordinate(groupId, artifactId, DEFAULT_VERSION, classifier, type);
	}

	/**
	 * Turns a Maven artifact coordinate into a string. This returns the same format
	 * that can be parsed by the MavenCoordinate.fromString() method.
	 * 
	 * @return stringified version of the coordinate
	 */
	public String toMavenString() {
		String out = groupId + ":" + artifactId;
		if (version != null && !version.isEmpty()) {
			out += ":" + version;
		}
		if (classifier != null && !classifier.isEmpty()) {
			out += ":" + classifier;
		}
		if (type != null && !type.isEmpty()) {
			out += "@" + type;
		}
		return out;
	}

	/**
	 * Turns a Maven artifact coordinate into a string. This is a lossy format that
	 * doesn't follow any known specification and only exists for backward
	 * compatibility with the build integration.
	 * 
	 * @return stringified version of the coordinate
	 */
	public String toCanonicalForm() {
		String out = groupId + ":" + artifactId;
		if (version != null && !version.isEmpty()) {
			if (type != null && !type.isEmpty()) {
				if (classifier != null && !classifier.isEmpty()) {
					out += ":" + classifier;
				}
				out += ":" + type;
			}
			out += ":" + version;
		}
		return out;
	}

	@Override
	public boolean equals(Object o) {
		if (this == o)
			return true;
		if (o == null || getClass() != o.getClass())
			return false;
		MavenCoordinate that = (MavenCoordinate) o;
		return groupId.equals(that.groupId) && artifactId.equals(that.artifactId)
				&& Objects.equals(version, that.version) && Objects.equals(classifier, that.classifier)
				&& Objects.equals(type, that.type);
	}

	@Override
	public int hashCode() {
		return Objects.hash(groupId, artifactId, version, classifier, type);
	}
}