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.workspaces.impl.MemoryFileSystemProvider;
019import java.nio.file.FileSystem;
020import java.util.ServiceLoader;
021import org.apiguardian.api.API;
022import org.apiguardian.api.API.Status;
023
024/**
025 * Service provider interface for a RAM-based file system provider.
026 *
027 * <p>This enables swapping out the default RAM file system implementation with a custom
028 * implementation by using Java's {@link ServiceLoader} mechanism.
029 *
030 * @author Ashley Scopes
031 * @since 0.0.1
032 * @deprecated this feature should never be needed by users of this library, and so has been
033 * deprecated for removal in v1.0.0.
034 */
035@API(since = "0.0.1", status = Status.STABLE)
036@Deprecated(since = "0.6.0", forRemoval = true)
037public interface RamFileSystemProvider {
038
039  /**
040   * Create the new file system.
041   *
042   * @param name the file system name to use.
043   * @return the file system object.
044   */
045  FileSystem createFileSystem(String name);
046
047  /**
048   * Get the service provider implementation to use.
049   *
050   * @return the first service provider implementation, or a default implementation if not provided.
051   */
052  static RamFileSystemProvider getInstance() {
053    return ServiceLoader
054        .load(RamFileSystemProvider.class)
055        .findFirst()
056        .orElseGet(MemoryFileSystemProvider::getInstance);
057  }
058}