KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > net > sf > invicta > api > InvictaProject


1 package net.sf.invicta.api;
2  
3 import java.util.List JavaDoc;
4 import java.util.Map JavaDoc;
5
6 /**
7  * An interface of an Invicta project defined in project definition files.
8  * Contains only read-only information.
9  */
10 public interface InvictaProject {
11
12     /**
13      * Returns the name of this project.
14      * @return String
15      */
16     public String JavaDoc getName();
17     
18     /**
19      * Returns the relative directory of this project.
20      * @return String
21      */
22     public String JavaDoc getDir();
23     
24     /**
25      * Returns the version of this project.
26      * @return String
27      */
28     public String JavaDoc getVersion();
29
30     /**
31      * Returns a property that is defined for this project.
32      * @param propertyName
33      * @return Property. null if a property with the given name is undefined.
34      */
35     public Property getProjectProperty(String JavaDoc propertyName);
36
37     /**
38      * Returns the value of a property that is defined for this project.
39      * @param propertyName
40      * @return String. Property value or null if undefined.
41      */
42     public String JavaDoc getProjectPropertyValue(String JavaDoc propertyName);
43
44     /**
45      * Returns a map of all defined project properties.
46      * @return Map. Key=String (property name), Value=Property
47      */
48     public Map JavaDoc getProjectPropertiesMap();
49
50     /**
51      * Returns a list of all defined project properties.
52      * @return List of Property objects.
53      */
54     public List JavaDoc getProjectProperties();
55
56     /**
57      * Returns a map of all defined general properties.
58      * @return Map. Key=String (property name), Value=Property
59      */
60     public Map JavaDoc getGeneralPropertiesMap();
61
62     /**
63      * Returns a list of all defined general properties.
64      * @return List of Property objects.
65      */
66     public List JavaDoc getGeneralProperties();
67     
68     /**
69      * Returns a component with the given name or null if a component
70      * with the given name is not defined.
71      * @param componentName
72      * @return InvictaComponent
73      */
74     public InvictaComponent getComponent(String JavaDoc componentName);
75
76     /**
77      * Returns a list of all components that are defined in this project.
78      * @return List of InvictaComponent objects.
79      */
80     public List JavaDoc getComponents();
81                     
82     /**
83      * Returns the global component of this project. This is the component
84      * that all components of the project automatically depends on, and is
85      * reposible for global initializations of the generated build script.
86      * @return InvictaComponent
87      */
88     public InvictaComponent getGlobalComponent();
89 }
90
Popular Tags