Revision 32467 branches/v2_0_0_prep/extensions/org.gvsig.installer/org.gvsig.installer.lib/org.gvsig.installer.lib.api/src/main/java/org/gvsig/installer/lib/api/InstallerInfo.java
| InstallerInfo.java | ||
|---|---|---|
| 31 | 31 |
|
| 32 | 32 |
|
| 33 | 33 |
/** |
| 34 |
* Information of a plugin that is used on the installation process. |
|
| 35 |
* This information is composed by next fields: |
|
| 36 |
* </br> |
|
| 37 |
* <li> |
|
| 38 |
* <lu><b>Code</b>: unique identifier for the plugin.</lu> |
|
| 39 |
* <lu><b>Name</b>: name of the plugin.</lu> |
|
| 40 |
* <lu><b>Decription</b>: brief description of the plugin functionality</lu> * |
|
| 41 |
* <lu><b>Version</b>: number of version.</lu> |
|
| 42 |
* <lu><b>Build</b>: build number.</lu> |
|
| 43 |
* <lu><b>State</b>: the state of the plugin (testing, RC1...).</lu> |
|
| 44 |
* <lu><b>Is Official</b>: if the plugin is official or if is a not official plugin.</lu> |
|
| 45 |
* <lu><b>Type</b>: plugin type (plugin, theme, translation...). Depending of this value a |
|
| 46 |
* different installation provider is selected to control the installation process.</lu> |
|
| 47 |
* <li> |
|
| 48 |
* |
|
| 34 | 49 |
* @author <a href="mailto:jpiera@gvsig.org">Jorge Piera Llodrá</a> |
| 35 | 50 |
*/ |
| 36 | 51 |
public interface InstallerInfo {
|
| 37 | 52 |
|
| 53 |
/** |
|
| 54 |
* @return |
|
| 55 |
* Gets the code of the plugin. |
|
| 56 |
*/ |
|
| 38 | 57 |
public String getCode(); |
| 39 | 58 |
|
| 40 | 59 |
public void setCode(String code); |
| 41 | 60 |
|
| 61 |
/** |
|
| 62 |
* @return |
|
| 63 |
* Gets the name of the plugin. |
|
| 64 |
*/ |
|
| 42 | 65 |
public String getName(); |
| 43 | 66 |
|
| 44 | 67 |
public void setName(String name); |
| 45 | 68 |
|
| 69 |
/** |
|
| 70 |
* @return |
|
| 71 |
* Gets the description of the plugin. |
|
| 72 |
*/ |
|
| 46 | 73 |
public String getDescription(); |
| 47 | 74 |
|
| 48 | 75 |
public void setDescription(String description); |
| 49 | 76 |
|
| 77 |
/** |
|
| 78 |
* @return |
|
| 79 |
* Gets the version of the plugin. |
|
| 80 |
*/ |
|
| 50 | 81 |
public String getVersion(); |
| 51 | 82 |
|
| 52 | 83 |
public void setVersion(String version); |
| 53 | 84 |
|
| 85 |
/** |
|
| 86 |
* @return |
|
| 87 |
* Gets the build number of the plugin. |
|
| 88 |
*/ |
|
| 54 | 89 |
public int getBuild(); |
| 55 | 90 |
|
| 56 | 91 |
public void setBuild(int build); |
| 57 | 92 |
|
| 93 |
/** |
|
| 94 |
* @return |
|
| 95 |
* Gets the state of the plugin. |
|
| 96 |
*/ |
|
| 58 | 97 |
public String getState(); |
| 59 | 98 |
|
| 60 | 99 |
public void setState(String state); |
| 61 | 100 |
|
| 101 |
/** |
|
| 102 |
* @return |
|
| 103 |
* Gets if the plugin is official. |
|
| 104 |
*/ |
|
| 62 | 105 |
public boolean isOfficial(); |
| 63 | 106 |
|
| 64 | 107 |
public void setOfficial(boolean official); |
| 65 |
|
|
| 108 |
|
|
| 109 |
/** |
|
| 110 |
* @return |
|
| 111 |
* Gets the type of the plugin. |
|
| 112 |
*/ |
|
| 113 |
public String getType(); |
|
| 114 |
|
|
| 115 |
public void setType(String type); |
|
| 116 |
|
|
| 117 |
/** |
|
| 118 |
* Add an external file that have to be copied in the |
|
| 119 |
* installation process. |
|
| 120 |
* @param file |
|
| 121 |
* The file to copy. |
|
| 122 |
* @deprecated |
|
| 123 |
* This method will be deleted on next releases because |
|
| 124 |
* all the files that a plugin needs to work should be |
|
| 125 |
* contained in its directory. |
|
| 126 |
*/ |
|
| 66 | 127 |
public void addFileToCopy(File file); |
| 67 | 128 |
|
| 129 |
/** |
|
| 130 |
* Gets one external file that is copied on |
|
| 131 |
* the installation process. |
|
| 132 |
* @param index |
|
| 133 |
* The position of the external file. |
|
| 134 |
* @return |
|
| 135 |
* The file that have to be copied. |
|
| 136 |
* @deprecated |
|
| 137 |
* This method will be deleted on next releases because |
|
| 138 |
* all the files that a plugin needs to work should be |
|
| 139 |
* contained in its directory. |
|
| 140 |
*/ |
|
| 68 | 141 |
public File getFileToCopyAt(int index); |
| 69 | 142 |
|
| 143 |
/** |
|
| 144 |
* Gest the number of external files that have to be |
|
| 145 |
* copied in the installation process. |
|
| 146 |
* @return |
|
| 147 |
* The number of files. |
|
| 148 |
* @deprecated |
|
| 149 |
* This method will be deleted on next releases because |
|
| 150 |
* all the files that a plugin needs to work should be |
|
| 151 |
* contained in its directory. |
|
| 152 |
*/ |
|
| 70 | 153 |
public int getFileToCopySize(); |
| 71 | 154 |
|
| 155 |
/** |
|
| 156 |
* Removes one of the files that have to be copied in the |
|
| 157 |
* installation process. |
|
| 158 |
* @param index |
|
| 159 |
* the position of the file. |
|
| 160 |
* @deprecated |
|
| 161 |
* This method will be deleted on next releases because |
|
| 162 |
* all the files that a plugin needs to work should be |
|
| 163 |
* contained in its directory. |
|
| 164 |
*/ |
|
| 72 | 165 |
public void removeFileToCopy(int index); |
| 73 | 166 |
|
| 167 |
/** |
|
| 168 |
* Sets the ant script that can be executed in the |
|
| 169 |
* installation process. |
|
| 170 |
* @param antScript |
|
| 171 |
* The ant script to copy. |
|
| 172 |
* @deprecated |
|
| 173 |
* This method will be deleted on next releases because |
|
| 174 |
* all the files that a plugin needs to work should be |
|
| 175 |
* contained in its directory. |
|
| 176 |
*/ |
|
| 74 | 177 |
public void setAnScript(String antScript); |
| 75 | 178 |
|
| 179 |
/** |
|
| 180 |
* Gets the ant script that has to be executed in the |
|
| 181 |
* installation process. |
|
| 182 |
* @return |
|
| 183 |
* the script. |
|
| 184 |
* @deprecated |
|
| 185 |
* This method will be deleted on next releases because |
|
| 186 |
* all the files that a plugin needs to work should be |
|
| 187 |
* contained in its directory. |
|
| 188 |
*/ |
|
| 76 | 189 |
public String getAntScript(); |
| 77 |
|
|
| 78 |
public String getType(); |
|
| 79 |
|
|
| 80 |
public void setType(String type); |
|
| 81 | 190 |
|
| 82 | 191 |
} |
| 83 | 192 |
|
Also available in: Unified diff