Skip to content

Commit cb42638

Browse files
elharoelharo
authored
some javadoc nits (#290)
* javadoc * ManifestConfiguration.java * MavenArchiveConfiguration.java
1 parent 5675312 commit cb42638

File tree

3 files changed

+40
-40
lines changed

3 files changed

+40
-40
lines changed

‎src/main/java/org/apache/maven/shared/archiver/ManifestConfiguration.java

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
*/
2424
// TODO Is this general enough to be in Plexus Archiver?
2525
public class ManifestConfiguration {
26+
2627
/**
2728
* The simple layout.
2829
*/
@@ -34,7 +35,7 @@ public class ManifestConfiguration {
3435
public static final String CLASSPATH_LAYOUT_TYPE_REPOSITORY = "repository";
3536

3637
/**
37-
* custom layout type.
38+
* Custom layout type.
3839
*/
3940
public static final String CLASSPATH_LAYOUT_TYPE_CUSTOM = "custom";
4041

@@ -97,7 +98,7 @@ public String getMainClass() {
9798
/**
9899
* <p>Getter for the field <code>packageName</code>.</p>
99100
*
100-
* @return the package name.
101+
* @return the package name
101102
*/
102103
public String getPackageName() {
103104
return packageName;
@@ -106,7 +107,7 @@ public String getPackageName() {
106107
/**
107108
* <p>isAddClasspath.</p>
108109
*
109-
* @return if addClasspath true or false.
110+
* @return if addClasspath true or false
110111
*/
111112
public boolean isAddClasspath() {
112113
return addClasspath;
@@ -160,7 +161,7 @@ public boolean isAddExtensions() {
160161
/**
161162
* <p>Setter for the field <code>addClasspath</code>.</p>
162163
*
163-
* @param addClasspath turn on addClasspath or off.
164+
* @param addClasspath turn on addClasspath or off
164165
*/
165166
public void setAddClasspath(boolean addClasspath) {
166167
this.addClasspath = addClasspath;
@@ -169,7 +170,7 @@ public void setAddClasspath(boolean addClasspath) {
169170
/**
170171
* <p>Setter for the field <code>addDefaultEntries</code>.</p>
171172
*
172-
* @param addDefaultEntries add default entries true/false.
173+
* @param addDefaultEntries add default entries true/false
173174
*/
174175
public void setAddDefaultEntries(boolean addDefaultEntries) {
175176
this.addDefaultEntries = addDefaultEntries;
@@ -178,7 +179,7 @@ public void setAddDefaultEntries(boolean addDefaultEntries) {
178179
/**
179180
* <p>Setter for the field <code>addBuildEnvironmentEntries</code>.</p>
180181
*
181-
* @param addBuildEnvironmentEntries add build environment information true/false.
182+
* @param addBuildEnvironmentEntries add build environment information true/false
182183
*/
183184
public void setAddBuildEnvironmentEntries(boolean addBuildEnvironmentEntries) {
184185
this.addBuildEnvironmentEntries = addBuildEnvironmentEntries;
@@ -187,7 +188,7 @@ public void setAddBuildEnvironmentEntries(boolean addBuildEnvironmentEntries) {
187188
/**
188189
* <p>Setter for the field <code>addDefaultImplementationEntries</code>.</p>
189190
*
190-
* @param addDefaultImplementationEntries true to add default implementations false otherwise.
191+
* @param addDefaultImplementationEntries true to add default implementations false otherwise
191192
*/
192193
public void setAddDefaultImplementationEntries(boolean addDefaultImplementationEntries) {
193194
this.addDefaultImplementationEntries = addDefaultImplementationEntries;
@@ -196,7 +197,7 @@ public void setAddDefaultImplementationEntries(boolean addDefaultImplementationE
196197
/**
197198
* <p>Setter for the field <code>addDefaultSpecificationEntries</code>.</p>
198199
*
199-
* @param addDefaultSpecificationEntries add default specifications true/false.
200+
* @param addDefaultSpecificationEntries add default specifications true/false
200201
*/
201202
public void setAddDefaultSpecificationEntries(boolean addDefaultSpecificationEntries) {
202203
this.addDefaultSpecificationEntries = addDefaultSpecificationEntries;
@@ -205,7 +206,7 @@ public void setAddDefaultSpecificationEntries(boolean addDefaultSpecificationEnt
205206
/**
206207
* <p>Setter for the field <code>addExtensions</code>.</p>
207208
*
208-
* @param addExtensions true to add extensions false otherwise.
209+
* @param addExtensions true to add extensions false otherwise
209210
*/
210211
public void setAddExtensions(boolean addExtensions) {
211212
this.addExtensions = addExtensions;
@@ -214,7 +215,7 @@ public void setAddExtensions(boolean addExtensions) {
214215
/**
215216
* <p>Setter for the field <code>classpathPrefix</code>.</p>
216217
*
217-
* @param classpathPrefix The prefix.
218+
* @param classpathPrefix the prefix
218219
*/
219220
public void setClasspathPrefix(String classpathPrefix) {
220221
this.classpathPrefix = classpathPrefix;
@@ -223,7 +224,7 @@ public void setClasspathPrefix(String classpathPrefix) {
223224
/**
224225
* <p>Setter for the field <code>mainClass</code>.</p>
225226
*
226-
* @param mainClass The main class.
227+
* @param mainClass the main class
227228
*/
228229
public void setMainClass(String mainClass) {
229230
this.mainClass = mainClass;
@@ -232,7 +233,7 @@ public void setMainClass(String mainClass) {
232233
/**
233234
* <p>Setter for the field <code>packageName</code>.</p>
234235
*
235-
* @param packageName The package name.
236+
* @param packageName the package name
236237
*/
237238
public void setPackageName(String packageName) {
238239
this.packageName = packageName;
@@ -241,15 +242,13 @@ public void setPackageName(String packageName) {
241242
/**
242243
* <p>Getter for the field <code>classpathPrefix</code>.</p>
243244
*
244-
* @return The classpath prefix.
245+
* @return the classpath prefix
245246
*/
246247
public String getClasspathPrefix() {
247248
String cpp = classpathPrefix.replaceAll("\\\\", "/");
248-
249249
if (cpp.length() != 0 && !cpp.endsWith("/")) {
250250
cpp += "/";
251251
}
252-
253252
return cpp;
254253
}
255254

@@ -261,7 +260,7 @@ public String getClasspathPrefix() {
261260
* <b>NOTE:</b> If you specify a type of 'custom' you MUST set
262261
* {@link ManifestConfiguration#setCustomClasspathLayout(String)}.
263262
*
264-
* @return The classpath layout type.
263+
* @return the classpath layout type
265264
*/
266265
public String getClasspathLayoutType() {
267266
return classpathLayoutType;
@@ -275,7 +274,7 @@ public String getClasspathLayoutType() {
275274
* <b>NOTE:</b> If you specify a type of 'custom' you MUST set
276275
* {@link ManifestConfiguration#setCustomClasspathLayout(String)}.
277276
*
278-
* @param classpathLayoutType The classpath layout type.
277+
* @param classpathLayoutType the classpath layout type
279278
*/
280279
public void setClasspathLayoutType(String classpathLayoutType) {
281280
this.classpathLayoutType = classpathLayoutType;
@@ -293,7 +292,7 @@ public void setClasspathLayoutType(String classpathLayoutType) {
293292
* <br>
294293
* <b>NOTE:</b> If you specify a layout type of 'custom' you MUST set this layout expression.
295294
*
296-
* @return The custom classpath layout.
295+
* @return the custom classpath layout
297296
*/
298297
public String getCustomClasspathLayout() {
299298
return customClasspathLayout;
@@ -319,7 +318,7 @@ public String getCustomClasspathLayout() {
319318
* </ol>
320319
* how such an expression looks like.
321320
*
322-
* @param customClasspathLayout The custom classpath layout.
321+
* @param customClasspathLayout the custom classpath layout
323322
*/
324323
public void setCustomClasspathLayout(String customClasspathLayout) {
325324
this.customClasspathLayout = customClasspathLayout;
@@ -332,7 +331,7 @@ public void setCustomClasspathLayout(String customClasspathLayout) {
332331
* <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on
333332
* that artifact's inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).
334333
*
335-
* @return The state of {@link #useUniqueVersions}
334+
* @return the state of {@link #useUniqueVersions}
336335
*/
337336
public boolean isUseUniqueVersions() {
338337
return useUniqueVersions;
@@ -345,7 +344,7 @@ public boolean isUseUniqueVersions() {
345344
* <b>NOTE:</b> If the snapshot was installed locally, this flag will not have an effect on that artifact's
346345
* inclusion, since it will have the same version either way (i.e. -SNAPSHOT naming).
347346
*
348-
* @param useUniqueVersions true to use unique versions or not.
347+
* @param useUniqueVersions true to use unique versions or not
349348
*/
350349
public void setUseUniqueVersions(boolean useUniqueVersions) {
351350
this.useUniqueVersions = useUniqueVersions;

‎src/main/java/org/apache/maven/shared/archiver/ManifestSection.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ public class ManifestSection {
3333
/**
3434
* <p>addManifestEntry.</p>
3535
*
36-
* @param key The key of the manifest entry.
37-
* @param value The appropriate value.
36+
* @param key the key of the manifest entry
37+
* @param value the appropriate value
3838
*/
3939
public void addManifestEntry(String key, String value) {
4040
manifestEntries.put(key, value);
@@ -43,7 +43,7 @@ public void addManifestEntry(String key, String value) {
4343
/**
4444
* <p>Getter for the field <code>manifestEntries</code>.</p>
4545
*
46-
* @return The entries.
46+
* @return the entries
4747
*/
4848
public Map<String, String> getManifestEntries() {
4949
return manifestEntries;
@@ -52,7 +52,7 @@ public Map<String, String> getManifestEntries() {
5252
/**
5353
* <p>Getter for the field <code>name</code>.</p>
5454
*
55-
* @return The name.
55+
* @return the name
5656
*/
5757
public String getName() {
5858
return name;
@@ -61,7 +61,7 @@ public String getName() {
6161
/**
6262
* <p>Setter for the field <code>name</code>.</p>
6363
*
64-
* @param name the name.
64+
* @param name the name
6565
*/
6666
public void setName(String name) {
6767
this.name = name;
@@ -70,7 +70,7 @@ public void setName(String name) {
7070
/**
7171
* <p>addManifestEntries.</p>
7272
*
73-
* @param map The map to add.
73+
* @param map the map to add
7474
*/
7575
public void addManifestEntries(Map<String, String> map) {
7676
manifestEntries.putAll(map);
@@ -79,7 +79,7 @@ public void addManifestEntries(Map<String, String> map) {
7979
/**
8080
* <p>isManifestEntriesEmpty.</p>
8181
*
82-
* @return true if empty false otherwise.
82+
* @return true if empty false otherwise
8383
*/
8484
public boolean isManifestEntriesEmpty() {
8585
return manifestEntries.isEmpty();

‎src/main/java/org/apache/maven/shared/archiver/MavenArchiveConfiguration.java

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
*/
3232
// TODO Is this general enough to be in Plexus Archiver?
3333
public class MavenArchiveConfiguration {
34+
3435
private boolean compress = true;
3536

3637
private boolean recompressAddedZips = true;
@@ -117,7 +118,7 @@ public ManifestConfiguration getManifest() {
117118
/**
118119
* <p>Setter for the field <code>compress</code>.</p>
119120
*
120-
* @param compress set compress to true/false.
121+
* @param compress set compress to true/false
121122
*/
122123
public void setCompress(boolean compress) {
123124
this.compress = compress;
@@ -126,7 +127,7 @@ public void setCompress(boolean compress) {
126127
/**
127128
* <p>Setter for the field <code>addMavenDescriptor</code>.</p>
128129
*
129-
* @param addMavenDescriptor activate to add maven descriptor or not.
130+
* @param addMavenDescriptor activate to add maven descriptor or not
130131
*/
131132
public void setAddMavenDescriptor(boolean addMavenDescriptor) {
132133
this.addMavenDescriptor = addMavenDescriptor;
@@ -135,7 +136,7 @@ public void setAddMavenDescriptor(boolean addMavenDescriptor) {
135136
/**
136137
* <p>Setter for the field <code>manifestFile</code>.</p>
137138
*
138-
* @param manifestFile The manifest file.
139+
* @param manifestFile the manifest file
139140
*/
140141
public void setManifestFile(Path manifestFile) {
141142
this.manifestFile = manifestFile;
@@ -153,8 +154,8 @@ public void setManifest(ManifestConfiguration manifest) {
153154
/**
154155
* <p>addManifestEntry.</p>
155156
*
156-
* @param key The key of the entry.
157-
* @param value The value of the entry.
157+
* @param key the key of the entry
158+
* @param value the value of the entry
158159
*/
159160
public void addManifestEntry(String key, String value) {
160161
manifestEntries.put(key, value);
@@ -163,7 +164,7 @@ public void addManifestEntry(String key, String value) {
163164
/**
164165
* <p>addManifestEntries.</p>
165166
*
166-
* @param map The whole map which should be added.
167+
* @param map the whole map which should be added
167168
*/
168169
public void addManifestEntries(Map<String, String> map) {
169170
manifestEntries.putAll(map);
@@ -172,7 +173,7 @@ public void addManifestEntries(Map<String, String> map) {
172173
/**
173174
* <p>isManifestEntriesEmpty.</p>
174175
*
175-
* @return are there entries true yes false otherwise.
176+
* @return are there entries true yes false otherwise
176177
*/
177178
public boolean isManifestEntriesEmpty() {
178179
return manifestEntries.isEmpty();
@@ -208,7 +209,7 @@ public void addManifestSection(ManifestSection section) {
208209
/**
209210
* <p>addManifestSections.</p>
210211
*
211-
* @param list Added list of {@link ManifestSection}.
212+
* @param list added list of {@link ManifestSection}
212213
*/
213214
public void addManifestSections(List<ManifestSection> list) {
214215
manifestSections.addAll(list);
@@ -217,7 +218,7 @@ public void addManifestSections(List<ManifestSection> list) {
217218
/**
218219
* <p>isManifestSectionsEmpty.</p>
219220
*
220-
* @return if manifestSections is empty or not.
221+
* @return if manifestSections is empty or not
221222
*/
222223
public boolean isManifestSectionsEmpty() {
223224
return manifestSections.isEmpty();
@@ -235,7 +236,7 @@ public List<ManifestSection> getManifestSections() {
235236
/**
236237
* <p>Setter for the field <code>manifestSections</code>.</p>
237238
*
238-
* @param manifestSections set The list of {@link ManifestSection}.
239+
* @param manifestSections set The list of {@link ManifestSection}
239240
*/
240241
public void setManifestSections(List<ManifestSection> manifestSections) {
241242
this.manifestSections = manifestSections;
@@ -255,7 +256,7 @@ public void setManifestSections(List<ManifestSection> manifestSections) {
255256
* ignored.
256257
* </p>
257258
*
258-
* @return True, if the target archive should always be created; false otherwise
259+
* @return true, if the target archive should always be created; false otherwise
259260
* @see #setForced(boolean)
260261
*/
261262
public boolean isForced() {
@@ -276,7 +277,7 @@ public boolean isForced() {
276277
* ignored.
277278
* </p>
278279
*
279-
* @param forced True, if the target archive should always be created; false otherwise
280+
* @param forced true, if the target archive should always be created; false otherwise
280281
* @see #isForced()
281282
*/
282283
public void setForced(boolean forced) {

0 commit comments

Comments
 (0)