001/*
002 * Copyright 2013 Atteo.
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 org.atteo.moonshine.directories;
017
018import java.io.IOException;
019
020public interface FileAccessorFactory {
021    /**
022     * Returns parameters object for JCommander.
023     */
024    Object getParameters();
025
026    /**
027     * Sets given layout.
028     */
029    void setWriteableLayout(WriteableDirectoryLayout subdirectoryLayout);
030
031    /**
032     * Adds read-only config directory to the created accessors.
033     */
034    void addConfigDir(String path);
035
036    /**
037     * Adds read-only data directory to the created accessors.
038     */
039    void addDataDir(String path);
040
041    /**
042     * Returns ready to use {@link FileAccessor}.
043     */
044    FileAccessor getFileAccessor() throws IOException;
045}