001/*
002 * Copyright (C) 2022 - 2024, 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.filemanagers;
017
018import io.github.ascopes.jct.workspaces.Workspace;
019
020/**
021 * Factory interface for building a file manager object.
022 *
023 * @author Ashley Scopes
024 * @since 0.0.1
025 */
026@FunctionalInterface
027public interface JctFileManagerFactory {
028
029  /**
030   * Create and configure a file manager for a workspace.
031   *
032   * @param workspace the workspace to access files in.
033   * @return the file manager.
034   */
035  JctFileManager createFileManager(Workspace workspace);
036}