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 io.github.ascopes.jct.utils.UtilityClass;
019import io.github.ascopes.jct.workspaces.impl.WorkspaceImpl;
020import org.apiguardian.api.API;
021import org.apiguardian.api.API.Status;
022
023/**
024 * Helpers to create new workspaces.
025 *
026 * @author Ashley Scopes
027 * @since 0.0.1
028 */
029@API(since = "0.0.1", status = Status.STABLE)
030public final class Workspaces extends UtilityClass {
031
032  private Workspaces() {
033    // Do nothing.
034  }
035
036  /**
037   * Create a new default workspace instance using the default path strategy.
038   *
039   * @return the workspace.
040   */
041  public static Workspace newWorkspace() {
042    return newWorkspace(PathStrategy.defaultStrategy());
043  }
044
045  /**
046   * Create a new default workspace instance using the given path strategy.
047   *
048   * @param pathStrategy the path strategy to use.
049   * @return the workspace.
050   */
051  public static Workspace newWorkspace(PathStrategy pathStrategy) {
052    return new WorkspaceImpl(pathStrategy);
053  }
054}