gvsig-scripting / org.gvsig.scripting / trunk / org.gvsig.scripting / org.gvsig.scripting.lib / org.gvsig.scripting.lib.api / src / main / java / org / gvsig / scripting / ScriptingFolder.java @ 989
History | View | Annotate | Download (1.43 KB)
1 |
package org.gvsig.scripting; |
---|---|
2 |
|
3 |
import java.io.File; |
4 |
import java.util.List; |
5 |
import java.util.function.Predicate; |
6 |
import org.gvsig.tools.exception.BaseException; |
7 |
import org.gvsig.tools.visitor.Visitable; |
8 |
import org.gvsig.tools.visitor.Visitor; |
9 |
|
10 |
/**
|
11 |
* <p> Interface that represents a directory in the ScriptingFramework.</p>
|
12 |
*
|
13 |
* @see ScriptingUnit
|
14 |
*/
|
15 |
public interface ScriptingFolder extends ScriptingUnit, Visitable { |
16 |
|
17 |
/**
|
18 |
* Adds a {@link ScriptingUnit} to the ScriptingFolder.
|
19 |
*
|
20 |
* @param unit
|
21 |
* {@link ScriptingUnit} to include.
|
22 |
*/
|
23 |
public void add(ScriptingUnit unit); |
24 |
|
25 |
/**
|
26 |
* Removes a {@link ScriptingUnit} from the ScriptingFolder.
|
27 |
*
|
28 |
* @param unit
|
29 |
* {@link ScriptingUnit} to delete.
|
30 |
*/
|
31 |
public void remove(ScriptingUnit unit); |
32 |
|
33 |
/**
|
34 |
* Returns the {@link ScriptingUnit} associated with a File.
|
35 |
*
|
36 |
* @param file
|
37 |
* File of the data origin.
|
38 |
*
|
39 |
* @return a {@link ScriptingUnit} with the content extracted from the file.
|
40 |
*/
|
41 |
public ScriptingUnit getUnit(File file); |
42 |
|
43 |
/**
|
44 |
* Gets all the {@link ScriptingUnit}s contained in a ScriptingFolder.
|
45 |
*
|
46 |
* @return a List with the {@link ScriptingUnit}s.
|
47 |
*
|
48 |
*/
|
49 |
public List<ScriptingUnit> getUnits(); |
50 |
|
51 |
public List<ScriptingFolder> getUnitFolders(); |
52 |
|
53 |
public boolean isLink(); |
54 |
|
55 |
public void accept(Visitor visitor, Predicate<ScriptingUnit> includeFilter) throws BaseException; |
56 |
|
57 |
public void save(); |
58 |
} |