2424 * Interface to be implemented by clients of the <code>org.eclipse.pde.build.fetchFactories</code> extension-point.
2525 * <p>
2626 * The factories are being used at various points in the execution of the PDE Build <code>eclipse.fetch</code> Ant task.
27- * Based on a map file entry, they are responsible for generating segments of an ant script whose execution will fetch
27+ * Based on a map file entry, they are responsible for generating segments of an ant script whose execution will fetch
2828 * plug-ins, fragments, bundles and features or individual files contained in one of those elements.
2929 * The format of a map file entry is:
3030 * <code>
3131 * <elementType>@<elementName> = <repositoryTag>, <repositoryDetails>
3232 * </code>
3333 * The format of <code>elementType</code> and <code>elementName</code> is fixed.
3434 * The factories specify the value of <code>repositoryTag</code> and the format of the <code>repositoryDetails</code>.
35- * <code>repositoryTag</code> and <code>repositoryDetails</code> becomes defacto APIs.
35+ * <code>repositoryTag</code> and <code>repositoryDetails</code> becomes defacto APIs.
3636 * <br>
37- * <code>repositoryTag</code> should match the factory id used when declaring the factory extension. For example, for the CVS the value is "CVS".
37+ * <code>repositoryTag</code> should match the factory id used when declaring the factory extension. For example, for the CVS the value is "CVS".
3838 * <code>repositoryDetails</code> should contains enough details to allow the factory to generate a fetch script retrieving the element.
3939 * </p>
4040 * <p>
41- * The fetch factories are being contributed through the <code>org.eclipse.pde.build.fetchFactories</code>
41+ * The fetch factories are being contributed through the <code>org.eclipse.pde.build.fetchFactories</code>
4242 * extension-points.
4343 * </p>
4444 * <p>
@@ -87,16 +87,16 @@ public interface IFetchFactory {
8787 * required in later processing to sucessfully generate the fetch script.
8888 * </p>
8989 * <p>
90- * Since 3.6, factories may optionally set the {@link Constants#KEY_SOURCE_REFERENCES} property in the entry infos map to support the inclusion
90+ * Since 3.6, factories may optionally set the {@link Constants#KEY_SOURCE_REFERENCES} property in the entry infos map to support the inclusion
9191 * of source references in the bundle manifest using the Eclipse-SourceReferences header.
9292 * </p>
9393 * @param rawEntry the arguments as specified in the map file (may not be <code>null</code>).
94- * @param overrideTags a key / value containing all the override tags specified for all the repository (maybe <code>null</code> or empty).
95- * The values of this map of this are read from the fetchTag property (see file scripts/templates/headless-build/build.properties).
96- * @param entryInfos the map to store repository specific information derived from the rawEntry.This object is being passed as arguments to
97- * the other methods of the factory. The factories are also expected to set {@link #KEY_ELEMENT_TAG} to indicate the tag that will be used
98- * to fetch the element. This value is for example used to generate the "qualifier" value of a version number.
99- * Note that {@link #KEY_ELEMENT_NAME} and {@link #KEY_ELEMENT_TYPE} are reserved entries whose values respectively
94+ * @param overrideTags a key / value containing all the override tags specified for all the repository (maybe <code>null</code> or empty).
95+ * The values of this map of this are read from the fetchTag property (see file scripts/templates/headless-build/build.properties).
96+ * @param entryInfos the map to store repository specific information derived from the rawEntry.This object is being passed as arguments to
97+ * the other methods of the factory. The factories are also expected to set {@link #KEY_ELEMENT_TAG} to indicate the tag that will be used
98+ * to fetch the element. This value is for example used to generate the "qualifier" value of a version number.
99+ * Note that {@link #KEY_ELEMENT_NAME} and {@link #KEY_ELEMENT_TYPE} are reserved entries whose values respectively
100100 * refer to the name of the element being fetched and its type.
101101 * @throws CoreException if the rawEntry is incorrect.
102102 */
@@ -108,8 +108,8 @@ public interface IFetchFactory {
108108 * @param entryInfos the map that has been built in the {@link #parseMapFileEntry(String, Properties, Map)} method.
109109 * This map contains the name and the type of the element (resp. {@link #KEY_ELEMENT_NAME} and {@link #KEY_ELEMENT_TYPE}) to put in the destination.
110110 * @param destination the destination where the element should be fetched to. For example, for a plug-in the <code>plugin.xml</code> file is expected
111- * to be in <code>destination/plugin.xml</code>.
112- * @param script the script in which to generate the segments of ant script. It is not authorized to generate target declaration during this call.
111+ * to be in <code>destination/plugin.xml</code>.
112+ * @param script the script in which to generate the segments of ant script. It is not authorized to generate target declaration during this call.
113113 */
114114 public void generateRetrieveElementCall (Map <String , Object > entryInfos , IPath destination , IAntScript script );
115115
@@ -119,15 +119,15 @@ public interface IFetchFactory {
119119 * @param entryInfos the map that has been built in the {@link #parseMapFileEntry(String, Properties, Map)} method.
120120 * This map contains the name and the type of the element (resp. {@link #KEY_ELEMENT_NAME} and {@link #KEY_ELEMENT_TYPE}) to put in the destination.
121121 * @param destination the destination where the element should be fetched to. For example, for a plug-in the <code>plugin.xml</code> file is expected
122- * to be in <code>destination/plugin.xml</code>.
122+ * to be in <code>destination/plugin.xml</code>.
123123 * @param files the files to obtained for the specified element.
124- * @param script the script in which to generate the segments of ant script. It is not authorized to generate target declaration during this call.
124+ * @param script the script in which to generate the segments of ant script. It is not authorized to generate target declaration during this call.
125125 */
126126 public void generateRetrieveFilesCall (Map <String , Object > entryInfos , IPath destination , String [] files , IAntScript script );
127127
128128 /**
129129 * This methods give opportunities to the factory to generate target declaration or other Ant top level constructs in the script.
130- * The generated elements can be invoked from the ant scripts segments created in {@link #generateRetrieveElementCall(Map, IPath, IAntScript)}
130+ * The generated elements can be invoked from the ant scripts segments created in {@link #generateRetrieveElementCall(Map, IPath, IAntScript)}
131131 * and {@link #generateRetrieveFilesCall(Map, IPath, String[], IAntScript)}.
132132 */
133133 public void addTargets (IAntScript script );
0 commit comments