001/*
002 * Copyright (C) 2022 - 2023, the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *    http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package io.github.ascopes.jct.workspaces;
017
018import java.io.File;
019import java.nio.file.Path;
020import org.apiguardian.api.API;
021import org.apiguardian.api.API.Status;
022
023/**
024 * Chainable builder for creating directories.
025 *
026 * @author Ashley Scopes
027 * @since 0.0.1
028 */
029@API(since = "0.0.1", status = Status.STABLE)
030public interface DirectoryBuilder {
031
032  /**
033   * Copy the contents of the directory at the given path recursively into this directory.
034   *
035   * <p>This uses the default file system.
036   *
037   * <p>Examples:
038   *
039   * <pre><code>
040   *   // Using platform-specific separators.
041   *   directoryBuilder.copyContentsFrom("foo/bar/baz");
042   *
043   *   // Letting JCT infer the correct path separators to use (recommended).
044   *   directoryBuilder.copyContentsFrom("foo", "bar", "baz");
045   * </code></pre>
046   *
047   * @param first the first part of the path to the directory to copy from.
048   * @param rest  any additional parts of the path.
049   * @return the root managed directory for further configuration.
050   */
051  ManagedDirectory copyContentsFrom(String first, String... rest);
052
053  /**
054   * Copy the contents of the directory at the given path recursively into this directory.
055   *
056   * @param dir the directory to copy the contents from.
057   * @return the root managed directory for further configuration.
058   */
059  ManagedDirectory copyContentsFrom(File dir);
060
061  /**
062   * Copy the contents of the directory at the given path recursively into this directory.
063   *
064   * @param rootDir the directory to copy the contents from.
065   * @return the root managed directory for further configuration.
066   */
067  ManagedDirectory copyContentsFrom(Path rootDir);
068
069  /**
070   * Create an empty directory.
071   *
072   * @return the root managed directory for further configuration.
073   */
074  ManagedDirectory thatIsEmpty();
075}