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 @ 441
History | View | Annotate | Download (1.04 KB)
1 |
package org.gvsig.scripting; |
---|---|
2 |
|
3 |
import java.io.File; |
4 |
import java.util.List; |
5 |
|
6 |
/**
|
7 |
* <p> Interface that represents a directory in the ScriptingFramework.</p>
|
8 |
*
|
9 |
* @see ScriptingUnit
|
10 |
*/
|
11 |
public interface ScriptingFolder extends ScriptingUnit{ |
12 |
|
13 |
/**
|
14 |
* Adds a {@link ScriptingUnit} to the ScriptingFolder.
|
15 |
*
|
16 |
* @param unit
|
17 |
* {@link ScriptingUnit} to include.
|
18 |
*/
|
19 |
public void add(ScriptingUnit unit); |
20 |
|
21 |
/**
|
22 |
* Removes a {@link ScriptingUnit} from the ScriptingFolder.
|
23 |
*
|
24 |
* @param unit
|
25 |
* {@link ScriptingUnit} to delete.
|
26 |
*/
|
27 |
public void remove(ScriptingUnit unit); |
28 |
|
29 |
/**
|
30 |
* Returns the {@link ScriptingUnit} associated with a File.
|
31 |
*
|
32 |
* @param file
|
33 |
* File of the data origin.
|
34 |
*
|
35 |
* @return a {@link ScriptingUnit} with the content extracted from the file.
|
36 |
*/
|
37 |
public ScriptingUnit getUnit(File file); |
38 |
|
39 |
/**
|
40 |
* Gets all the {@link ScriptingUnit}s contained in a ScriptingFolder.
|
41 |
*
|
42 |
* @return a List with the {@link ScriptingUnit}s.
|
43 |
*
|
44 |
*/
|
45 |
public List<ScriptingUnit> getUnits(); |
46 |
|
47 |
} |