package org.litesoft.textfiledirectory;

import org.litesoft.commonfoundation.annotations.*;
import org.litesoft.core.simpletypes.*;

public interface TextFileDirectory
{
    public class FileAlreadyExists extends TextFileDirectoryException
    {
        public FileAlreadyExists( String message )
        {
            super( message );
        }
    }

    public class FileDoesNotExists extends TextFileDirectoryException
    {
        public FileDoesNotExists( String message )
        {
            super( message );
        }
    }

    /**
     * Return the Directory path <i>behind</i> this TextFileDirectory.
     */
    String getDirectoryPath();

    /**
     * Return if the Directory represented by this instance currently exists.
     */
    boolean exists();

    /**
     * Get the list of File Names that have the extension(s) indicated by <code>pExtensions</code>, no extensions means all files.
     *
     * @param pExtensions of the files of interest without the '.', e.g. "txt" or "java" (the extension is case sensitive).
     *
     * @return Non Null String array (may be an empty array) of the file names (with the extensions) found.
     */
    @NotNull String[] getFiles( String... pExtensions );

    TextFile load( @NotNull String pFileName )
            throws FileDoesNotExists;

    void create( @NotNull TextFile pFile )
            throws FileAlreadyExists;

    void update( @NotNull TextFile pFile )
            throws FileDoesNotExists;

    void delete( @NotNull TextFile pFile )
            throws FileDoesNotExists;

    void delete( @NotNull String pFileName )
            throws FileDoesNotExists;
}