FileAccessorFactory.java

/*
 * Copyright 2013 Atteo.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.atteo.moonshine.directories;

import java.io.IOException;

public interface FileAccessorFactory {
	/**
	 * Returns parameters object for JCommander.
	 */
	Object getParameters();

	/**
	 * Sets given layout.
	 */
	void setWriteableLayout(WriteableDirectoryLayout subdirectoryLayout);

	/**
	 * Adds read-only config directory to the created accessors.
	 */
	void addConfigDir(String path);

	/**
	 * Adds read-only data directory to the created accessors.
	 */
	void addDataDir(String path);

	/**
	 * Returns ready to use {@link FileAccessor}.
	 */
	FileAccessor getFileAccessor() throws IOException;
}