Skip to content

Commit 6315808

Browse files
krosenvoldkrosenvold
committed
More jsf305
1 parent eac1602 commit 6315808

File tree

11 files changed

+95
-51
lines changed

11 files changed

+95
-51
lines changed

‎src/main/java/org/codehaus/plexus/archiver/AbstractArchiver.java

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@
3131
import java.util.Map;
3232
import java.util.NoSuchElementException;
3333
import java.util.Set;
34+
35+
import javax.annotation.Nonnull;
36+
3437
import org.codehaus.plexus.PlexusConstants;
3538
import org.codehaus.plexus.PlexusContainer;
3639
import org.codehaus.plexus.archiver.manager.ArchiverManager;
@@ -251,36 +254,36 @@ public void setIncludeEmptyDirs( final boolean includeEmptyDirs )
251254
this.includeEmptyDirs = includeEmptyDirs;
252255
}
253256

254-
public void addDirectory( final File directory )
257+
public void addDirectory( @Nonnull final File directory )
255258
throws ArchiverException
256259
{
257260
addFileSet( fileSet( directory ).prefixed( "" )
258261
.includeExclude( null, null ).includeEmptyDirs( includeEmptyDirs ) );
259262
}
260263

261-
public void addDirectory( final File directory, final String prefix )
264+
public void addDirectory( @Nonnull final File directory, final String prefix )
262265
throws ArchiverException
263266
{
264267
addFileSet( fileSet( directory ).prefixed( prefix )
265268
.includeExclude( null, null ).includeEmptyDirs( includeEmptyDirs ) );
266269
}
267270

268-
public void addDirectory( final File directory, final String[] includes, final String[] excludes )
271+
public void addDirectory( @Nonnull final File directory, final String[] includes, final String[] excludes )
269272
throws ArchiverException
270273
{
271274
addFileSet( fileSet( directory ).prefixed( "" )
272275
.includeExclude( includes, excludes ).includeEmptyDirs( includeEmptyDirs ) );
273276
}
274277

275-
public void addDirectory( final File directory, final String prefix, final String[] includes,
278+
public void addDirectory( @Nonnull final File directory, final String prefix, final String[] includes,
276279
final String[] excludes )
277280
throws ArchiverException
278281
{
279282
addFileSet( fileSet( directory ).prefixed( prefix )
280283
.includeExclude( includes, excludes ).includeEmptyDirs( includeEmptyDirs ) );
281284
}
282285

283-
public void addFileSet( final FileSet fileSet )
286+
public void addFileSet( @Nonnull final FileSet fileSet )
284287
throws ArchiverException
285288
{
286289
final File directory = fileSet.getDirectory();
@@ -328,7 +331,7 @@ private boolean isSymlinkSupported()
328331
Java7Reflector.isAtLeastJava7();
329332
}
330333

331-
public void addFile( final File inputFile, final String destFileName )
334+
public void addFile( @Nonnull final File inputFile, @Nonnull final String destFileName )
332335
throws ArchiverException
333336
{
334337
final int fileMode = getOverrideFileMode();
@@ -350,7 +353,7 @@ public void addSymlink(String symlinkName, int permissions, String symlinkDestin
350353
resources.add( ArchiveEntry.createSymlinkEntry( symlinkName, permissions, symlinkDestination ) );
351354
}
352355

353-
protected ArchiveEntry asArchiveEntry( final PlexusIoResource resource, final String destFileName,
356+
protected ArchiveEntry asArchiveEntry( @Nonnull final PlexusIoResource resource, final String destFileName,
354357
final int permissions )
355358
throws ArchiverException
356359
{
@@ -402,7 +405,7 @@ public void addResource( final PlexusIoResource resource, final String destFileN
402405
resources.add( asArchiveEntry( resource, destFileName, permissions ) );
403406
}
404407

405-
public void addFile( final File inputFile, String destFileName, int permissions )
408+
public void addFile( @Nonnull final File inputFile, @Nonnull String destFileName, int permissions )
406409
throws ArchiverException
407410
{
408411
if ( !inputFile.isFile() || !inputFile.exists() )
@@ -453,6 +456,7 @@ public void addFile( final File inputFile, String destFileName, int permissions
453456
}
454457
}
455458

459+
@Nonnull
456460
public ResourceIterator getResources()
457461
throws ArchiverException
458462
{
@@ -723,7 +727,7 @@ public void addArchivedFileSet( final ArchivedFileSet fileSet )
723727
/**
724728
* @since 1.0-alpha-7
725729
*/
726-
public void addArchivedFileSet( final File archiveFile, final String prefix, final String[] includes,
730+
public void addArchivedFileSet( @Nonnull final File archiveFile, final String prefix, final String[] includes,
727731
final String[] excludes )
728732
throws ArchiverException
729733
{
@@ -737,7 +741,7 @@ public void addArchivedFileSet( final File archiveFile, final String prefix, fin
737741
/**
738742
* @since 1.0-alpha-7
739743
*/
740-
public void addArchivedFileSet( final File archiveFile, final String prefix )
744+
public void addArchivedFileSet( @Nonnull final File archiveFile, final String prefix )
741745
throws ArchiverException
742746
{
743747
addArchivedFileSet(
@@ -749,7 +753,7 @@ public void addArchivedFileSet( final File archiveFile, final String prefix )
749753
/**
750754
* @since 1.0-alpha-7
751755
*/
752-
public void addArchivedFileSet( final File archiveFile, final String[] includes, final String[] excludes )
756+
public void addArchivedFileSet( @Nonnull final File archiveFile, final String[] includes, final String[] excludes )
753757
throws ArchiverException
754758
{
755759
addArchivedFileSet(
@@ -761,7 +765,7 @@ public void addArchivedFileSet( final File archiveFile, final String[] includes,
761765
/**
762766
* @since 1.0-alpha-7
763767
*/
764-
public void addArchivedFileSet( final File archiveFile )
768+
public void addArchivedFileSet( @Nonnull final File archiveFile )
765769
throws ArchiverException
766770
{
767771
addArchivedFileSet( archivedFileSet( archiveFile ).includeEmptyDirs( includeEmptyDirs ) );

‎src/main/java/org/codehaus/plexus/archiver/ArchiveEntry.java

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919

2020
import org.codehaus.plexus.archiver.resources.PlexusIoVirtualSymlinkResource;
2121
import org.codehaus.plexus.archiver.util.ArchiverAttributeUtils;
22+
import java.io.File;
23+
import java.io.IOException;
24+
import java.io.InputStream;
25+
26+
import javax.annotation.Nonnull;
27+
2228
import org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributeUtils;
2329
import org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes;
2430
import org.codehaus.plexus.components.io.resources.PlexusIoFileResource;
@@ -42,7 +48,7 @@ public class ArchiveEntry
4248
public static final int DIRECTORY = 2;
4349

4450
public static final int SYMLINK = 3;
45-
private final PlexusIoResource resource;
51+
@Nonnull private PlexusIoResource resource;
4652

4753
private final String name;
4854

@@ -59,7 +65,7 @@ public class ArchiveEntry
5965
* @param type FILE or DIRECTORY
6066
* @param mode octal unix style permissions
6167
*/
62-
private ArchiveEntry( String name, PlexusIoResource resource, int type, int mode )
68+
private ArchiveEntry( String name, @Nonnull PlexusIoResource resource, int type, int mode )
6369
{
6470
this.name = name;
6571
this.resource = resource;
@@ -171,7 +177,7 @@ public static ArchiveEntry createFileEntry( String target, File file, int permis
171177
return new ArchiveEntry( target, res, FILE, permissions );
172178
}
173179

174-
public static ArchiveEntry createDirectoryEntry( String target, PlexusIoResource resource, int permissions )
180+
public static ArchiveEntry createDirectoryEntry( String target, @Nonnull PlexusIoResource resource, int permissions )
175181
throws ArchiverException
176182
{
177183
if ( !resource.isDirectory() )
@@ -228,7 +234,7 @@ public void setResourceAttributes( PlexusIoResourceAttributes attributes )
228234
this.attributes = attributes;
229235
}
230236

231-
public PlexusIoResource getResource()
237+
public @Nonnull PlexusIoResource getResource()
232238
{
233239
return resource;
234240
}

‎src/main/java/org/codehaus/plexus/archiver/ArchivedFileSet.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
import java.io.File;
44

5+
import javax.annotation.CheckForNull;
6+
57

68
/**
79
* A file set, which consists of the files and directories in
@@ -14,5 +16,6 @@ public interface ArchivedFileSet
1416
/**
1517
* Returns the archive file.
1618
*/
19+
@CheckForNull
1720
File getArchive();
1821
}

‎src/main/java/org/codehaus/plexus/archiver/Archiver.java

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,8 @@
2626
import java.util.Map;
2727
import java.util.Set;
2828

29+
import javax.annotation.Nonnull;
30+
2931
/**
3032
* @version $Revision$ $Date$
3133
*/
@@ -56,7 +58,7 @@ public interface Archiver
5658

5759
public static final String DUPLICATES_FAIL = "fail";
5860

59-
public static final Set DUPLICATES_VALID_BEHAVIORS = new HashSet()
61+
public static final Set<String> DUPLICATES_VALID_BEHAVIORS = new HashSet<String>()
6062
{
6163
private static final long serialVersionUID = 1L;
6264

@@ -77,7 +79,7 @@ void createArchive()
7779
* IDE to get the proper implementation for this release.
7880
*/
7981
@Deprecated
80-
void addDirectory( File directory )
82+
void addDirectory( @Nonnull File directory )
8183
throws ArchiverException;
8284

8385
/**
@@ -86,24 +88,23 @@ void addDirectory( File directory )
8688
* IDE to get the proper implementation for this release.
8789
*/
8890
@Deprecated
89-
void addDirectory( File directory, String prefix )
91+
void addDirectory( @Nonnull File directory, String prefix )
9092
throws ArchiverException;
9193

9294
/**
9395
* Obsolete, use {@link #addFileSet(FileSet)}.You can use "inline" of this method in your
9496
* IDE to get the proper implementation for this release.
9597
*/
9698
@Deprecated
97-
void addDirectory( File directory, String[] includes, String[] excludes )
99+
void addDirectory( @Nonnull File directory, String[] includes, String[] excludes )
98100
throws ArchiverException;
99101

100102
/**
101103
* Obsolete, use {@link #addFileSet(FileSet)}.
102104
* You can use "inline" of this method in your
103105
* IDE to get the proper implementation for this release.
104106
*/
105-
@Deprecated
106-
void addDirectory( File directory, String prefix, String[] includes, String[] excludes )
107+
void addDirectory( @Nonnull File directory, String prefix, String[] includes, String[] excludes )
107108
throws ArchiverException;
108109

109110
/**
@@ -116,7 +117,7 @@ void addDirectory( File directory, String prefix, String[] includes, String[] ex
116117
* Adding the file set failed.
117118
* @since 1.0-alpha-9
118119
*/
119-
void addFileSet( FileSet fileSet )
120+
void addFileSet( @Nonnull FileSet fileSet )
120121
throws ArchiverException;
121122

122123
void addSymlink(String symlinkName, String symlinkDestination)
@@ -125,17 +126,17 @@ void addSymlink(String symlinkName, String symlinkDestination)
125126
void addSymlink(String symlinkName, int permissions, String symlinkDestination)
126127
throws ArchiverException;
127128

128-
void addFile( File inputFile, String destFileName )
129+
void addFile( @Nonnull File inputFile, @Nonnull String destFileName )
129130
throws ArchiverException;
130131

131-
void addFile( File inputFile, String destFileName, int permissions )
132+
void addFile( @Nonnull File inputFile, @Nonnull String destFileName, int permissions )
132133
throws ArchiverException;
133134
/**
134135
* Obsolete, use {@link #addArchivedFileSet(ArchivedFileSet)}. You can use "inline" of this method in your
135136
* IDE to get the proper implementation for this release.
136137
* @deprecated Will go away in next major version
137138
*/
138-
void addArchivedFileSet( File archiveFile )
139+
void addArchivedFileSet( @Nonnull File archiveFile )
139140
throws ArchiverException;
140141

141142
/**
@@ -144,7 +145,7 @@ void addArchivedFileSet( File archiveFile )
144145
* @deprecated Will go away in next major version
145146
*/
146147
@Deprecated
147-
void addArchivedFileSet( File archiveFile, String prefix )
148+
void addArchivedFileSet( @Nonnull File archiveFile, String prefix )
148149
throws ArchiverException;
149150

150151
/**
@@ -160,7 +161,7 @@ void addArchivedFileSet( File archiveFile, String[] includes, String[] excludes
160161
* IDE to get the proper implementation for this release.
161162
* @deprecated Will go away in next major version
162163
*/
163-
void addArchivedFileSet( File archiveFile, String prefix, String[] includes, String[] excludes )
164+
void addArchivedFileSet( @Nonnull File archiveFile, String prefix, String[] includes, String[] excludes )
164165
throws ArchiverException;
165166

166167
/**
@@ -233,6 +234,7 @@ void addResources( PlexusIoResourceCollection resources )
233234
*
234235
* @since 1.0-alpha-10
235236
*/
237+
@Nonnull
236238
ResourceIterator getResources()
237239
throws ArchiverException;
238240

‎src/main/java/org/codehaus/plexus/archiver/BaseFileSet.java

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
package org.codehaus.plexus.archiver;
22

3+
import javax.annotation.CheckForNull;
4+
35
import org.codehaus.plexus.components.io.fileselectors.FileSelector;
46
import org.codehaus.plexus.components.io.functions.InputStreamTransformer;
57

@@ -17,18 +19,21 @@ public interface BaseFileSet
1719
* Returns the prefix, which the file sets contents shall
1820
* have.
1921
*/
20-
String getPrefix();
22+
@CheckForNull
23+
String getPrefix();
2124

2225
/**
2326
* Returns a string of patterns, which included files
2427
* should match.
2528
*/
29+
@CheckForNull
2630
String[] getIncludes();
2731

2832
/**
2933
* Returns a string of patterns, which excluded files
3034
* should match.
3135
*/
36+
@CheckForNull
3237
String[] getExcludes();
3338

3439
/**
@@ -52,6 +57,7 @@ public interface BaseFileSet
5257
* Returns a set of file selectors, which should be used
5358
* to select the included files.
5459
*/
60+
@CheckForNull
5561
FileSelector[] getFileSelectors();
5662

5763
/**

‎src/main/java/org/codehaus/plexus/archiver/bzip2/PlexusIoBzip2ResourceCollection.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class PlexusIoBzip2ResourceCollection
3030
try
3131
{
3232
final InputStream result = BZip2UnArchiver.getBZip2InputStream( fis );
33-
fis = null;
33+
fis = null;
3434
return result;
3535
}
3636
finally

‎src/main/java/org/codehaus/plexus/archiver/manager/ArchiverManager.java

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020

2121
import java.io.File;
2222

23+
import javax.annotation.Nonnull;
24+
2325
import org.codehaus.plexus.archiver.Archiver;
2426
import org.codehaus.plexus.archiver.UnArchiver;
2527
import org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection;
@@ -32,21 +34,22 @@ public interface ArchiverManager
3234
{
3335
String ROLE = ArchiverManager.class.getName();
3436

35-
Archiver getArchiver( String archiverName )
37+
@Nonnull Archiver getArchiver( @Nonnull String archiverName )
3638
throws NoSuchArchiverException;
3739

38-
Archiver getArchiver( File file )
40+
@Nonnull Archiver getArchiver( @Nonnull File file )
3941
throws NoSuchArchiverException;
4042

41-
UnArchiver getUnArchiver( String unArchiverName )
43+
@Nonnull UnArchiver getUnArchiver( @Nonnull String unArchiverName )
4244
throws NoSuchArchiverException;
4345

44-
UnArchiver getUnArchiver( File file )
46+
@Nonnull UnArchiver getUnArchiver( @Nonnull File file )
4547
throws NoSuchArchiverException;
4648

47-
PlexusIoResourceCollection getResourceCollection( File file )
49+
@Nonnull PlexusIoResourceCollection getResourceCollection( @Nonnull File file )
4850
throws NoSuchArchiverException;
4951

52+
@Nonnull
5053
PlexusIoResourceCollection getResourceCollection( String unArchiverName )
5154
throws NoSuchArchiverException;
5255
}

0 commit comments

Comments
 (0)