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.compilers.JctCompiler;
019import io.github.ascopes.jct.filemanagers.impl.JctFileManagerFactoryImpl;
020import io.github.ascopes.jct.utils.UtilityClass;
021import org.apiguardian.api.API;
022import org.apiguardian.api.API.Status;
023
024/**
025 * Helpers to create instances of default implementations for file managers.
026 *
027 * @author Ashley Scopes
028 * @since 1.1.0
029 */
030@API(since = "1.1.0", status = Status.STABLE)
031public final class JctFileManagers extends UtilityClass {
032
033  private JctFileManagers() {
034    // Static-only class.
035  }
036
037  /**
038   * Create a new default implementation of a file manager factory.
039   *
040   * @param compiler the JctCompiler to bind any file managers to.
041   * @return the file manager factory instance.
042   */
043  public static JctFileManagerFactory newJctFileManagerFactory(JctCompiler compiler) {
044    return new JctFileManagerFactoryImpl(compiler);
045  }
046}