package com.planet_ink.coffee_web.interfaces;

import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.RandomAccessFile;
/*
   Copyright 2012-2022 Bo Zimmerman

   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.
*/
import java.io.FileNotFoundException;

/**
 * Manages File objects
 * @author Bo Zimmerman
 *
 */
public interface FileManager
{
	/**
	 * Return the appropriate file separator for this fs
	 * @return the file separator string
	 */
	public char getFileSeparator();
	/**
	 * Create a file object from the given local path
	 * @param localPath the path c:\dljl\sdf\ format.
	 * @return a local File object
	 */
	public File createFileFromPath(String localPath);
	/**
	 * Create a file object from the given local path
	 * @param parent the parent path c:\dljl\sdf\ format.
	 * @param localPath the path c:\dljl\sdf\ format.
	 * @return a local File object
	 */
	public File createFileFromPath(File parent, String localPath);
	/**
	 * Read the data out out of the given file
	 * @param file the file to read
	 * @return all the byte data from the file
	 * @throws IOException a read error
	 * @throws FileNotFoundException the file was not found
	 */
	public byte[] readFile(File file) throws IOException, FileNotFoundException;

	/**
	 * Return a readable input stream of the given files data
	 * @param file the file to read
	 * @return an open input stream for reading.
	 * @throws IOException a read error
	 * @throws FileNotFoundException the file was not found
	 */
	public InputStream getFileStream(File file) throws IOException, FileNotFoundException;

	/**
	 * Returns whether the given file can be randomly accessed
	 * @param file the filemanager file to check for random access support.
	 * @return true if it can, or false otherwise
	 */
	public boolean supportsRandomAccess(File file);

	/**
	 * Return a readable input stream of the given files data
	 * @param file the file to read
	 * @return an open input stream for reading.
	 * @throws IOException a read error
	 * @throws FileNotFoundException the file was not found
	 */
	public RandomAccessFile getRandomAccessFile(File file) throws IOException, FileNotFoundException;

	/**
	 * Returns true if the file exists and is readable and meets any other
	 * criteria the manager desires before deciding whether to allow reading.
	 * @param file the file from this manager to check
	 * @return true to proceed with reading, or false otherwise
	 */
	public boolean allowedToReadData(File file);
}
