org.eclipse.aether.util.DirectoryUtils Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-contract-shade Show documentation
Spring Cloud Contract Shaded Dependencies
There is a newer version: 4.1.4
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.eclipse.aether.util;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;

import org.eclipse.aether.RepositorySystemSession;

import static java.util.Objects.requireNonNull;

/**
 * A utility class to calculate (and create if needed) paths backed by directories using configuration properties from
 * repository system session and others.
 *
 * @see RepositorySystemSession#getConfigProperties()
 * @see RepositorySystemSession#getLocalRepository()
 * @since 1.9.0
 */
public final class DirectoryUtils {
    private DirectoryUtils() {
        // hide constructor
    }

    /**
     * Creates {@link Path} instance out of passed in {@code name} parameter. May create a directory on resulting path,
     * if not exist, when invoked with {@code mayCreate} being {@code true}. Never returns {@code null}.
     * 
     * Following outcomes may happen:
     * 

     *     {@code name} is absolute path - results in {@link Path} instance created directly from name.
     *     {@code name} is relative path - results in {@link Path} instance resolved against {@code base} parameter.
     *     
     * 
     * Resulting path is being checked is a directory, and if not, it will be created if {@code mayCreate} is
     * {@code true}. If resulting path exist but is not a directory, this method will throw.
     *
     * @param name      The name to create directory with, cannot be {@code null}.
     * @param base      The base {@link Path} to resolve name, if it is relative path, cannot be {@code null}.
     * @param mayCreate If resulting path does not exist, should it create?
     * @return The {@link Path} instance that is resolved and backed by existing directory.
     * @throws IOException If some IO related errors happens.
     */
    public static Path resolveDirectory(String name, Path base, boolean mayCreate) throws IOException {
        requireNonNull(name, "name is null");
        requireNonNull(base, "base is null");
        final Path namePath = Paths.get(name);
        final Path result;
        if (namePath.isAbsolute()) {
            result = namePath.normalize();
        } else {
            result = base.resolve(namePath).normalize();
        }

        if (!Files.exists(result)) {
            if (mayCreate) {
                Files.createDirectories(result);
            }
        } else if (!Files.isDirectory(result)) {
            throw new IOException("Path exists, but is not a directory: " + result);
        }
        return result;
    }

    /**
     * Creates {@link Path} instance out of session configuration, and (if relative) resolve it against local
     * repository basedir. Pre-populates values and invokes {@link #resolveDirectory(String, Path, boolean)}.
     * 
     * For this method to work, {@link org.eclipse.aether.repository.LocalRepository#getBasedir()} must return
     * non-{@code null} value, otherwise {@link NullPointerException} is thrown.
     *
     * @param session     The session, may not be {@code null}.
     * @param defaultName The default value if not present in session configuration, may not be {@code null}.
     * @param nameKey     The key to look up for in session configuration to obtain user set value.
     * @param mayCreate   If resulting path does not exist, should it create?
     * @return The {@link Path} instance that is resolved and backed by existing directory.
     * @throws IOException If some IO related errors happens.
     * @see #resolveDirectory(String, Path, boolean)
     */
    public static Path resolveDirectory(
            RepositorySystemSession session, String defaultName, String nameKey, boolean mayCreate) throws IOException {
        requireNonNull(session, "session is null");
        requireNonNull(defaultName, "defaultName is null");
        requireNonNull(nameKey, "nameKey is null");
        requireNonNull(session.getLocalRepository().getBasedir(), "session.localRepository.basedir is null");
        return resolveDirectory(
                ConfigUtils.getString(session, defaultName, nameKey),
                session.getLocalRepository().getBasedir().toPath(),
                mayCreate);
    }
}