org.kuali.common.util.project.ProjectUtils 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-2013 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;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

import org.kuali.common.util.Assert;
import org.kuali.common.util.Str;
import org.kuali.common.util.maven.MavenConstants;

public class ProjectUtils {

	private static final String CLASSPATH = "classpath:";

	/**
	 * Convert a project id into a ProjectIdentifier's
	 * 
	 * Example project id:
	 * 
	 * 	 *   org.kuali.common:kuali-util
	 * 
	 */
	public static ProjectIdentifier getIdentifier(String projectId) {

		// Project id can't be blank
		Assert.notBlank(projectId, "project id is blank");

		// Split up the id
		String[] tokens = Str.split(projectId, ":", true);

		// Must always have exactly 2 tokens
		Assert.isTrue(tokens.length == 2, "tokens.length != 2");

		// 1st token is groupId, 2nd token is artifactId
		String groupId = tokens[0];
		String artifactId = tokens[1];

		// Create a project identifier from the strings
		return new ImmutableProjectIdentifier(groupId, artifactId);
	}

	/**
	 * Convert a list of project ids into a list of ProjectIdentifier's
	 * 
	 * Example project id:
	 * 
	 * 	 *   org.kuali.common:kuali-util
	 * 
	 */
	public static List getIdentifiers(List projectIds) {
		List list = new ArrayList();
		for (String projectId : projectIds) {
			ProjectIdentifier element = getIdentifier(projectId);
			list.add(element);
		}
		return list;
	}

	/**
	 * Convenience method for extracting the value of the property project.encoding
	 */
	public static String getEncoding(Project project) {
		return project.getProperties().getProperty(MavenConstants.ENCODING_KEY);
	}

	/**
	 * Return a resource directory relative to directory
	 * 
	 * 	 *   /tmp/x/y/z + org.kuali.common:kuali-util  ->  /tmp/x/y/z/org/kuali/common/kuali-util
	 * 
	 */
	public static File getResourceDirectory(File directory, String groupId, String artifactId) {
		String path = getResourcePath(groupId, artifactId);
		return new File(directory, path);
	}

	/**
	 * Return a resource friendly prefix.
	 * 
	 * 	 *   org.kuali.common:kuali-util  ->  org/kuali/common/kuali-util
	 * 
	 */
	public static String getResourcePath(String groupId, String artifactId) {
		return Str.getPath(groupId) + "/" + artifactId;
	}

	/**
	 * Return a classpath prefix.
	 * 
	 * 	 *   org.kuali.common:kuali-util  ->  classpath:org/kuali/common/kuali-util
	 * 
	 */
	public static String getClassPathPrefix(String groupId, String artifactId) {
		return CLASSPATH + getResourcePath(groupId, artifactId);
	}

}