Package org.codehaus.plexus.archiver
Class ArchiveEntry
java.lang.Object
org.codehaus.plexus.archiver.ArchiveEntry
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final boolean
private org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes
private final int
static final int
static final int
private final int
private final String
private final org.codehaus.plexus.components.io.resources.PlexusIoResource
static final String
static final int
private final int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
ArchiveEntry
(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
Modifier and TypeMethodDescriptionstatic ArchiveEntry
createDirectoryEntry
(String target, File file, int permissions, int defaultDirMode1) static ArchiveEntry
createDirectoryEntry
(String target, org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, int defaultDirectoryPermissions) static ArchiveEntry
createFileEntry
(String target, File file, int permissions, int defaultDirectoryPermissions) static ArchiveEntry
createFileEntry
(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
(String symlinkName, int permissions, String symlinkDestination, int defaultDirectoryPermissions) int
getFile()
Deprecated.int
getMode()
getName()
org.codehaus.plexus.components.io.resources.PlexusIoResource
org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes
int
getType()
void
setResourceAttributes
(org.codehaus.plexus.components.io.attributes.PlexusIoResourceAttributes attributes) boolean
Indicates if this entry should be added to the archive synchronously before adding the next entry and/or accessing the next entry ofResourceIterator
.
-
Field Details
-
ROLE
-
FILE
public static final int FILE- See Also:
-
DIRECTORY
public static final int DIRECTORY- See Also:
-
SYMLINK
public static final int SYMLINK- See Also:
-
resource
-
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 Details
-
ArchiveEntry
private ArchiveEntry(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 Details
-
getName
- Returns:
- the filename of this entry in the archive.
-
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
- Returns:
- The resource contents.
- Throws:
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(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(String target, File file, int permissions, int defaultDirectoryPermissions) throws ArchiverException, IOException - Throws:
ArchiverException
IOException
-
createDirectoryEntry
public static ArchiveEntry createDirectoryEntry(String target, @Nonnull org.codehaus.plexus.components.io.resources.PlexusIoResource resource, int permissions, int defaultDirectoryPermissions) throws ArchiverException - Throws:
ArchiverException
-
createDirectoryEntry
public static ArchiveEntry createDirectoryEntry(String target, File file, int permissions, int defaultDirMode1) throws ArchiverException, IOException - Throws:
ArchiverException
IOException
-
createSymlinkEntry
public static ArchiveEntry createSymlinkEntry(String symlinkName, int permissions, 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
-
getDefaultDirMode
public int getDefaultDirMode()
-
PlexusIoResource
.