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