org.kuali.common.util.project.model.ProjectIdentifier Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kuali-util Show documentation

Kuali Utilities

There is a newer version: 4.4.17

/**
 * Copyright 2010-2014 The Kuali Foundation
 *
 * Licensed under the Educational Community License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.opensource.org/licenses/ecl2.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.kuali.common.util.project.model;

import static org.kuali.common.util.ObjectUtils.equalsByToString;
import static org.kuali.common.util.base.Precondition.checkNotBlank;

/**
 * The project identifier concept is based on two facts:
 * 
 * 
 * 1 - All Kuali projects produce only one artifact containing executable java code and associated resources.

 * 2 - There is only one version of any given Kuali project in the java classpath.

 * 
 * 
 * 
 * Thus, groupId + artifactId is a simple way to uniquely namespace project resources at runtime.
 * 
 * For example, files residing in the kuali-util project at the following locations:
 * 
 * 
 *   src/main/resources/org/kuali/common/kuali-util/foo.txt
 *   src/main/resources/org/kuali/common/kuali-util/bar.txt
 * 
 * 
 * Can be uniquely referenced at runtime as:
 * 
 *  *   classpath:org/kuali/common/kuali-util/foo.txt
 *   classpath:org/kuali/common/kuali-util/bar.txt
 * 
 * 
 * 
 */
public final class ProjectIdentifier {

	private final String groupId;
	private final String artifactId;

	private final String identifier;
	private final int hashCode;

	public ProjectIdentifier(String groupId, String artifactId) {
		checkNotBlank(groupId, "groupId");
		checkNotBlank(artifactId, "artifactId");

		// Finish setting things up
		this.groupId = groupId;
		this.artifactId = artifactId;
		this.identifier = groupId + ":" + artifactId;
		this.hashCode = identifier.hashCode();
	}

	public String getGroupId() {
		return this.groupId;
	}

	public String getArtifactId() {
		return this.artifactId;
	}

	public String getIdentifier() {
		return identifier;
	}

	@Override
	public String toString() {
		return identifier;
	}

	@Override
	public int hashCode() {
		return hashCode;
	}

	@Override
	public boolean equals(Object object) {
		return equalsByToString(this, object);
	}

}