aQute.maven.api.Program Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of biz.aQute.bnd
The newest version!
package aQute.maven.api;

import java.util.Map;
import java.util.WeakHashMap;

import aQute.bnd.version.MavenVersion;
import aQute.lib.strings.Strings;

/**
 * In Maven, the groupId and artifactId represent an anonymous concept. This
 * concept is represented by this class.
 * 
 * We do not validate the groupId and artifactId because it is completely
 * unclear what the character set and syntax is :-(
 */
public class Program implements Comparable {
	public final String							group;
	public final String							artifact;
	public final String							path;

	final private static Map	programCache	= new WeakHashMap<>();
	final private Map	revisionCache	= new WeakHashMap<>();

	Program(String group, String artifact) {
		this.group = group;
		this.artifact = artifact;
		this.path = group.replace('.', '/') + "/" + artifact;
	}

	/**
	 * Create a revision by giving it a version
	 * 
	 * @param version the version
	 * @return the revision
	 */
	public synchronized Revision version(String version) {
		MavenVersion v = new MavenVersion(version);
		return version(v);
	}

	/**
	 * Create a revision by giving it a version
	 * 
	 * @param version the version
	 * @return the revision
	 */
	public synchronized Revision version(MavenVersion version) {
		Revision r = revisionCache.get(version);
		if (r == null) {
			r = new Revision(this, version);
			revisionCache.put(version, r);
		}
		return r;
	}

	static String validate(String gav) {
		String parts[] = gav.split(":");
		return validate(parts);
	}

	static String validate(String parts[]) {
		if (parts.length != 1)
			return "A GAV must consists of at least of ::";

		if (!isValidName(parts[0]))
			return "Invalid group " + parts[0];

		if (!isValidName(parts[1]))
			return "Invalid artifact " + parts[1];

		return null;
	}

	/**
	 * Validate if this is a valid g:a pair.
	 * 
	 * @param string the g:a pair
	 * @return true if valid, false otherwise
	 */
	public static boolean isValidName(String string) {
		if (string == null || string.isEmpty())
			return false;

		return true;
	}

	@Override
	public int hashCode() {
		final int prime = 31;
		int result = 1;
		result = prime * result + group.hashCode();
		result = prime * result + artifact.hashCode();
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj)
			return true;
		if (obj == null)
			return false;
		if (getClass() != obj.getClass())
			return false;

		Program other = (Program) obj;
		if (!artifact.equals(other.artifact))
			return false;

		if (!group.equals(other.group))
			return false;

		return true;
	}

	@Override
	public String toString() {
		return group + ":" + artifact;
	}

	/**
	 * Creates a program out of a g:a
	 * 
	 * @param group the g
	 * @param artifact the a
	 * @return the Program
	 */
	public static Program valueOf(String group, String artifact) {

		synchronized (programCache) {
			String key = group + ":" + artifact;
			Program p = programCache.get(key);
			if (p == null) {
				p = new Program(group, artifact);
				programCache.put(key, p);
			}
			return p;
		}
	}

	/**
	 * @return Return the remote path to the program's metadata
	 */
	public String metadata() {
		return path + "/maven-metadata.xml";
	}

	/**
	 * @return Return the local path to the program's metadata. The id is the id
	 *         of the repository
	 */
	public String metadata(String id) {
		return path + "/maven-metadata-" + id + ".xml";
	}

	public static Program valueOf(String bsn) {
		String parts[] = Strings.trim(bsn)
			.split(":");
		if (parts.length != 2)
			return null;

		return valueOf(parts[0], parts[1]);
	}

	@Override
	public int compareTo(Program o) {
		int n = group.compareTo(o.group);
		if (n != 0)
			return n;

		return artifact.compareTo(o.artifact);
	}
}