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.config;
017
018import io.github.ascopes.jct.filemanagers.JctFileManager;
019import io.github.ascopes.jct.utils.StringUtils;
020import io.github.ascopes.jct.workspaces.Workspace;
021import org.apiguardian.api.API;
022import org.apiguardian.api.API.Status;
023import org.slf4j.Logger;
024import org.slf4j.LoggerFactory;
025
026/**
027 * Configurer for a file manager that applies the given workspace.
028 *
029 * @author Ashley Scopes
030 * @since 0.0.1
031 */
032@API(since = "0.0.1", status = Status.STABLE)
033public final class JctFileManagerWorkspaceConfigurer implements JctFileManagerConfigurer {
034
035  private static final Logger LOGGER
036      = LoggerFactory.getLogger(JctFileManagerWorkspaceConfigurer.class);
037
038  private final Workspace workspace;
039
040  /**
041   * Initialise the configurer with the desired workspace.
042   *
043   * @param workspace the workspace to wrap.
044   */
045  public JctFileManagerWorkspaceConfigurer(Workspace workspace) {
046    this.workspace = workspace;
047  }
048
049  @Override
050  public JctFileManager configure(JctFileManager fileManager) {
051    LOGGER.debug("Configuring file manager with user-provided paths");
052
053    workspace.getAllPaths().forEach((location, paths) -> {
054      LOGGER
055          .atTrace()
056          .setMessage("Adding paths from workspace location {} into file manager ({})")
057          .addArgument(() -> StringUtils.quoted(location.getName()))
058          .addArgument(() -> StringUtils.quotedIterable(paths))
059          .log();
060      fileManager.addPaths(location, paths);
061    });
062
063    return fileManager;
064  }
065}