Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting;

import java.io.File;

import java.io.IOException;

import java.util.List;

import java.util.function.Predicate;

import org.gvsig.tools.exception.BaseException;

import org.gvsig.tools.visitor.Visitable;

import org.gvsig.tools.visitor.Visitor;

/**

 * <p>

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

 *

 * @see ScriptingUnit

 */

public interface ScriptingFolder extends ScriptingUnit, Visitable {

    /**

     * 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);

    public ScriptingUnit getUnit(String path);

    /**

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

     *

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

     *

     */

    public List<ScriptingUnit> getUnits();

    public List<ScriptingFolder> getUnitFolders();

    public boolean isLink();

    public void accept(Visitor visitor, Predicate<ScriptingUnit> includeFilter) throws BaseException;

    public void save();

    public String getRawInf();

    public void setRawInf(String rawInf);

    public String getProperty(String group, String name);

    public void setProperty(String group, String name, String value);

    public void setIconNames(String iconName, String iconNameOpen);

}