Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.util.List;

/**

 * <p> Interface that represents a directory in the ScriptingFramework.</p>

 * 

 * @see ScriptingUnit

 */

public interface ScriptingFolder  extends ScriptingUnit{

        /**

         * Adds a {@link ScriptingUnit} to the ScriptingFolder.

         *

         * @param unit

         *            {@link ScriptingUnit} to include.

         */

        public void add(ScriptingUnit unit);

        /**

         * Removes a {@link ScriptingUnit} from the ScriptingFolder.

         *

         * @param unit

         *            {@link ScriptingUnit} to delete.

         */

        public void remove(ScriptingUnit unit);

        /**

         * Returns the {@link ScriptingUnit} associated with a File.

         *

         * @param file

         *            File of the data origin.

         *            

         * @return a {@link ScriptingUnit} with the content extracted from the file.

         */

        public ScriptingUnit getUnit(File file);

        /**

         * Gets all the {@link ScriptingUnit}s contained in a ScriptingFolder.

         *            

         * @return a List with the {@link ScriptingUnit}s.

         *

         */

        public List<ScriptingUnit> getUnits();

        /**

         * Gets the path of the ScriptingFolder.

         * Use getPathFile as a prefered option.

         *            

         * @return a String with the ScriptingFolder's path.

         *

         */

        public String getPath();

        /**

         * Gets the path of the ScriptingFolder.

         *            

         * @return a File with the ScriptingFolder's path.

         *

         */

        public File getPathFile();

}