Package org.codehaus.plexus.archiver
Class ArchiveEntry
- java.lang.Object
-
- org.codehaus.plexus.archiver.ArchiveEntry
-
public class ArchiveEntry extends java.lang.Object
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
addSynchronously
private org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes
attributes
private int
defaultDirMode
static int
DIRECTORY
static int
FILE
private int
mode
private java.lang.String
name
private org.codehaus.plexus.components.io.resources.PlexusIoResource
resource
static java.lang.String
ROLE
static int
SYMLINK
private int
type
-
Constructor Summary
Constructors Modifier Constructor Description private
ArchiveEntry(java.lang.String name, org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int type, int mode, org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection, int defaultDirMode)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static ArchiveEntry
createDirectoryEntry(java.lang.String target, java.io.File file, int permissions, int defaultDirMode1)
static ArchiveEntry
createDirectoryEntry(java.lang.String target, org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, int defaultDirectoryPermissions)
static ArchiveEntry
createFileEntry(java.lang.String target, java.io.File file, int permissions, int defaultDirectoryPermissions)
static ArchiveEntry
createFileEntry(java.lang.String target, org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection, int defaultDirectoryPermissions)
static ArchiveEntry
createSymlinkEntry(java.lang.String symlinkName, int permissions, java.lang.String symlinkDestination, int defaultDirectoryPermissions)
int
getDefaultDirMode()
java.io.File
getFile()
Deprecated.As of 1.0-alpha-10, file entries are no longer backed by files, but by instances ofPlexusIoResource
.java.io.InputStream
getInputStream()
int
getMode()
java.lang.String
getName()
org.codehaus.plexus.components.io.resources.PlexusIoResource
getResource()
org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes
getResourceAttributes()
int
getType()
void
setResourceAttributes(org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes attributes)
boolean
shouldAddSynchronously()
Indicates if this entry should be added to the archive synchronously before adding the next entry and/or accessing the next entry ofResourceIterator
.
-
-
-
Field Detail
-
ROLE
public static final java.lang.String ROLE
-
FILE
public static final int FILE
- See Also:
- Constant Field Values
-
DIRECTORY
public static final int DIRECTORY
- See Also:
- Constant Field Values
-
SYMLINK
public static final int SYMLINK
- See Also:
- Constant Field Values
-
resource
@Nonnull private org.codehaus.plexus.components.io.resources.PlexusIoResource resource
-
name
private final java.lang.String name
-
type
private final int type
-
mode
private final int mode
-
defaultDirMode
private final int defaultDirMode
-
attributes
private org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes attributes
-
addSynchronously
private final boolean addSynchronously
-
-
Constructor Detail
-
ArchiveEntry
private ArchiveEntry(java.lang.String name, @Nonnull org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int type, int mode, org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection, int defaultDirMode)
- Parameters:
name
- the filename as it will appear in the archive. This is platform-specific normalized with File.separatorCharresource
- original filenametype
- FILE or DIRECTORYmode
- octal unix style permissionscollection
-defaultDirMode
-
-
-
Method Detail
-
getName
public java.lang.String getName()
- Returns:
- the filename of this entry in the archive.
-
getFile
@Deprecated public java.io.File getFile()
Deprecated.As of 1.0-alpha-10, file entries are no longer backed by files, but by instances ofPlexusIoResource
. Consequently, you should usegetInputStream()
-- Returns:
- The original file that will be stored in the archive.
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOException
- Returns:
- The resource contents.
- Throws:
java.io.IOException
-
getType
public int getType()
- Returns:
- FILE or DIRECTORY
-
getMode
public int getMode()
- Returns:
- octal user/group/other unix like permissions.
-
shouldAddSynchronously
public boolean shouldAddSynchronously()
Indicates if this entry should be added to the archive synchronously before adding the next entry and/or accessing the next entry ofResourceIterator
.- Returns:
true
if this entry should be added synchronously
-
createFileEntry
public static ArchiveEntry createFileEntry(java.lang.String target, org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, org.codehaus.plexus.components.io.resources.PlexusIoResourceCollection collection, int defaultDirectoryPermissions) throws ArchiverException
- Throws:
ArchiverException
-
createFileEntry
public static ArchiveEntry createFileEntry(java.lang.String target, java.io.File file, int permissions, int defaultDirectoryPermissions) throws ArchiverException, java.io.IOException
- Throws:
ArchiverException
java.io.IOException
-
createDirectoryEntry
public static ArchiveEntry createDirectoryEntry(java.lang.String target, @Nonnull org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, int defaultDirectoryPermissions) throws ArchiverException
- Throws:
ArchiverException
-
createDirectoryEntry
public static ArchiveEntry createDirectoryEntry(java.lang.String target, java.io.File file, int permissions, int defaultDirMode1) throws ArchiverException, java.io.IOException
- Throws:
ArchiverException
java.io.IOException
-
createSymlinkEntry
public static ArchiveEntry createSymlinkEntry(java.lang.String symlinkName, int permissions, java.lang.String symlinkDestination, int defaultDirectoryPermissions)
-
getResourceAttributes
public org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes getResourceAttributes()
-
setResourceAttributes
public void setResourceAttributes(org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes attributes)
-
getResource
@Nonnull public org.codehaus.plexus.components.io.resources.PlexusIoResource getResource()
-
getDefaultDirMode
public int getDefaultDirMode()
-
-