org.kuali.common.util.properties.DefaultPropertiesLocationService 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.properties;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import org.kuali.common.util.project.ProjectService;
import org.kuali.common.util.project.ProjectUtils;
import org.kuali.common.util.project.model.Project;
import org.kuali.common.util.project.model.ProjectIdentifier;
import org.kuali.common.util.project.model.ProjectResource;

import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;

public class DefaultPropertiesLocationService implements PropertiesLocationService {

	public DefaultPropertiesLocationService(ProjectService projectService) {
		this(projectService, DEFAULT_CACHE_PROPERTIES_VALUE);
	}

	public DefaultPropertiesLocationService(ProjectService projectService, boolean cache) {
		Preconditions.checkNotNull(projectService, "'projectService' cannot be null");
		this.projectService = projectService;
		this.cache = cache;
	}

	private static final boolean DEFAULT_CACHE_PROPERTIES_VALUE = true;

	private final ProjectService projectService;
	private final boolean cache;

	@Override
	public List getLocations(ProjectIdentifier identifier, List filenames) {
		List locations = new ArrayList();
		for (String filename : filenames) {
			locations.add(getLocation(identifier, filename));
		}
		return locations;
	}

	@Override
	public List getLocations(ProjectIdentifier identifier, String... filenames) {
		return getLocations(identifier, Arrays.asList(filenames));
	}

	@Override
	public Location getLocation(ProjectIdentifier identifier, String filename) {
		Project project = projectService.getProject(identifier);
		String value = ProjectUtils.getClasspathPrefix(identifier) + "/" + filename;
		String encoding = ProjectUtils.getEncoding(project);
		return new Location(value, encoding, cache);
	}

	/**
	 * @deprecated
	 */
	@Deprecated
	@Override
	public List getLocations(org.kuali.common.util.project.model.FeatureIdentifier identifier, String... filenames) {
		return getLocations(identifier, ImmutableList.copyOf(filenames));
	}

	/**
	 * @deprecated
	 */
	@Deprecated
	@Override
	public List getLocations(org.kuali.common.util.project.model.FeatureIdentifier identifier, List filenames) {
		List locations = new ArrayList();
		for (String filename : filenames) {
			locations.add(getLocation(identifier, filename));
		}
		return locations;
	}

	/**
	 * @deprecated
	 */
	@Deprecated
	@Override
	public Location getLocation(org.kuali.common.util.project.model.FeatureIdentifier identifier, String filename) {
		Project project = projectService.getProject(identifier.getProject());
		String value = ProjectUtils.getClasspathPrefix(identifier) + "/" + filename;
		String encoding = ProjectUtils.getEncoding(project);
		return new Location(value, encoding, cache);
	}

	@Override
	public Location getLocation(ProjectResource resource) {
		return getLocation(resource.getProject(), resource.getPath());
	}
}