Application: gvSIG desktop » Library: org.gvsig.tools

package org.gvsig.tools.resourcesstorage;

import java.io.Closeable;

import java.io.IOException;

import java.io.InputStream;

import java.io.OutputStream;

import java.net.URI;

import java.net.URL;

import java.util.List;

/**

 *

 * @author jjdelcerro

 */

@SuppressWarnings("UseSpecificCatch")

public interface ResourcesStorage {

    public interface Resource extends Closeable {

        /**

         * Return the name of the resource.

         * With this name, can be rebuild the resource from the ResourcesStorage.

         * 

         * @return name of the resource

         */

        public String getName(); 

        /**

         * El recurso es de solo lectura, normalmente por que el tipo de recurso

         * no permite escribir sobre el.

         * 

         * Podria devolver false, y a pesar de ello no poder escribir, normalmente

         * por carecer de permisos para ello.

         * 

         * @return 

         */

        public boolean isReadOnly();

        public URL getURL();

        public boolean exists();

        public InputStream asInputStream() throws IOException;

        public OutputStream asOutputStream() throws IOException;

        @Override

        public void close();

    }

    public static final ResourcesStorage EMPTY_RESOURCESSTORAGE = new EmptyResourcesStorage();

    public static ResourcesStorage createFilesResourcesStorage(String pathName) {

        return new FilesResourcesStorage(pathName);

    }

    public static MultiResourcesStorage createMultiResourcesStorage() {

        return new BaseMultiResourcesStorage();

    }   

    public static Resource createResource(String name, URL url) {

        try {

            return new URLResource(name, url);

        } catch (Exception ex) {

            return null;

        }

    }

    public static Resource createResource(String name, URI uri) {

        try {

            return new URLResource(name, uri.toURL());

        } catch (Exception ex) {

            return null;

        }

    }

    public String getSeparator();

    public Resource getResource(String resourceName);

    public List<Resource> getResources(String resourceName);

    public Resource getLocalizedResource(String resourceName);

    public List<Resource> getLocalizedResources(String resourceName);

    public boolean isEmpty();

    public boolean isReadOnly();

    public boolean exists(String resourceName);

    /**

     * Return the resource names in this store.

     * If the storage don't have resources, return a empty list.

     * 

     * @return list of resource names or empty list.

     */

    public List<String> getResourceNames();

}