org.jboss.forge.addon.resource.zip

Interface ZipFileResource

All Superinterfaces:

Faceted<ResourceFacet>, FileResource<ZipFileResource>, Resource<File>, WriteableResource<FileResource<ZipFileResource>,File>

public interface ZipFileResource
extends FileResource<ZipFileResource>

Handles a Zip file and provide operations related to it

Author:

George Gastaldi

Method Summary

Modifier and Type	Method and Description
ZipFileResource	add(FileResource<?>... resources) Add the specified resources to this Zip file
ZipFileResource	add(String name, Resource<?> resource) Add the specified Resource to this Zip file with the given name
void	extractTo(DirectoryResource directoryResource) Unzip all files to the specified DirectoryResource.
boolean	isEncrypted()
ZipFileResource	setPassword(char[] password) Sets the password for this ZipFileResource

Methods inherited from interface org.jboss.forge.addon.resource.FileResource

createNewFile, createTempResource, deleteOnExit, getLastModified, getParent, getSize, isDirectory, isExecutable, isReadable, isStale, isWritable, mkdir, mkdirs, monitor, monitor, moveTo, refresh, renameTo, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setWritable, setWritable

Methods inherited from interface org.jboss.forge.addon.resource.WriteableResource

getResourceOutputStream, getResourceOutputStream, setContents, setContents, setContents, setContents, setContents

Methods inherited from interface org.jboss.forge.addon.resource.Resource

createFrom, delete, delete, exists, getChild, getContents, getContents, getFullyQualifiedName, getName, getResourceFactory, getResourceInputStream, getUnderlyingResourceObject, listResources, listResources, reify, resolveChildren

Methods inherited from interface org.jboss.forge.addon.facets.Faceted

getFacet, getFacetAsOptional, getFacets, getFacets, hasAllFacets, hasAllFacets, hasFacet, supports

Method Detail

extractTo

void extractTo(DirectoryResource directoryResource)

Unzip all files to the specified DirectoryResource.

Parameters:

directoryResource - the target directory

add

ZipFileResource add(FileResource<?>... resources)

Add the specified resources to this Zip file

Parameters:

resources - the FileResource instances to be added

Returns:

this ZipFileResource instance, for method chaining

add

ZipFileResource add(String name,
                    Resource<?> resource)

Add the specified Resource to this Zip file with the given name

Parameters:

name - the file name inside the Zip

resource - the Resource instance to be added

Returns:

this ZipFileResource instance, for method chaining

setPassword

ZipFileResource setPassword(char[] password)

Sets the password for this ZipFileResource

Parameters:

password - the password to be used when reading this file

Returns:

this ZipFileResource instance, for method chaining

isEncrypted

boolean isEncrypted()

Returns:

true if this Zip file is encrypted