KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > invicta > dumper > InvictaDumper


1 package net.sf.invicta.dumper;
2
3 import net.sf.invicta.InvictaException;
4 import net.sf.invicta.api.InvictaProject;
5 import net.sf.invicta.process.ConfigurationManager;
6
7 /**
8  * An interface of a dumper. This interface is the exposed view of a
9  * dumper that the dumpers manager of the Invicta process is using.
10  * Any class that implements this interface and registers itself will
11  * be called by the dumpers manager.
12  */
13 public interface InvictaDumper {
14     
15     /**
16      * Returns the unique name of this dumper.
17      * @return String. Dumper's name.
18      */
19     public String JavaDoc getName();
20     
21     /**
22      * Initialization of this dumper with the configuration manager
23      * of Invicta process.
24      * @param configurationManager
25      */
26     public void init(ConfigurationManager configurationManager);
27
28     /**
29      * Sets the project that should be dumped.
30      * @param project
31      */
32     public void setProject(InvictaProject project);
33     
34     /**
35      * Performs the actual dumping of the project.
36      * @throws InvictaException
37      */
38     public void dump() throws InvictaException;
39     
40     /**
41      * Returns whether this dumper is enabled. Reads the property
42      * 'enabled' of this dumper.
43      * @return boolean
44      * @throws InvictaException
45      */
46     public boolean isEnabled() throws InvictaException;
47                     
48     /**
49      * Returns whether this dumper should force Invicta processing.
50      * This default implementation checks whether the output file is
51      * missing.
52      * @return boolean
53      * @throws InvictaException
54      */
55     public boolean shouldForceRunning() throws InvictaException;
56 }
57
Popular Tags