org.apache.tools.ant.types.resources

Class CompressedResource

Implemented Interfaces:
Cloneable, Comparable, ResourceCollection
Known Direct Subclasses:
BZip2Resource, GZipResource

public abstract class CompressedResource
extends Resource

A compressed resource.

Wraps around another resource, delegates all queries (except getSize) to that other resource but uncompresses/compresses streams on the fly.

Since:
Ant 1.7

Field Summary

Fields inherited from class org.apache.tools.ant.types.Resource

MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

Constructor Summary

CompressedResource()
no arg constructor
CompressedResource(ResourceCollection other)
Constructor with another resource to wrap.

Method Summary

void
addConfigured(ResourceCollection a)
Sets the resource to wrap using a single-element collection.
int
compareTo(Object other)
Delegates to a comparison of names.
protected abstract String
getCompressionName()
InputStream
getInputStream()
Get an InputStream for the Resource.
long
getLastModified()
Tells the modification time in milliseconds since 01.01.1970 .
String
getName()
Get the name of the resource.
OutputStream
getOutputStream()
Get an OutputStream for the Resource.
long
getSize()
Get the size of this Resource.
int
hashCode()
Get the hash code for this Resource.
boolean
isDirectory()
Tells if the resource is a directory.
boolean
isExists()
The exists attribute tells whether a file exists.
boolean
isFilesystemOnly()
Fulfill the ResourceCollection contract.
void
setDirectory(boolean directory)
Override setDirectory.
void
setExists(boolean exists)
Set the exists attribute.
void
setLastModified(long lastmodified)
Override setLastModified.
void
setName(String name)
Overridden, not allowed to set the name of the resource.
void
setRefid(Reference r)
Overrides the base version.
void
setSize(long size)
Override setSize.
String
toString()
Get the string representation of this Resource.
protected abstract InputStream
wrapStream(InputStream in)
Is supposed to wrap the stream to allow decompression on the fly.
protected abstract OutputStream
wrapStream(OutputStream out)
Is supposed to wrap the stream to allow compression on the fly.

Methods inherited from class org.apache.tools.ant.types.Resource

clone, compareTo, equals, getInputStream, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isExists, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setRefid, setSize, size, toLongString, toString

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

CompressedResource

public CompressedResource()
no arg constructor

CompressedResource

public CompressedResource(ResourceCollection other)
Constructor with another resource to wrap.
Parameters:
other - the resource to wrap.

Method Details

addConfigured

public void addConfigured(ResourceCollection a)
Sets the resource to wrap using a single-element collection.
Parameters:
a - the resource to wrap as a single element Resource collection.

compareTo

public int compareTo(Object other)
Delegates to a comparison of names.
Overrides:
compareTo in interface Resource
Parameters:
other - the object to compare to.
Returns:
a negative integer, zero, or a positive integer as this Resource is less than, equal to, or greater than the specified Resource.

getCompressionName

protected abstract String getCompressionName()
Returns:
the name of the compression method.

getInputStream

public InputStream getInputStream()
            throws IOException
Get an InputStream for the Resource.
Overrides:
getInputStream in interface Resource
Returns:
an InputStream containing this Resource's content.

getLastModified

public long getLastModified()
Tells the modification time in milliseconds since 01.01.1970 .
Overrides:
getLastModified in interface Resource
Returns:
0 if the resource does not exist to mirror the behavior of File.

getName

public String getName()
Get the name of the resource.
Overrides:
getName in interface Resource
Returns:
the name of the wrapped resource.

getOutputStream

public OutputStream getOutputStream()
            throws IOException
Get an OutputStream for the Resource.
Overrides:
getOutputStream in interface Resource
Returns:
an OutputStream to which content can be written.

getSize

public long getSize()
Get the size of this Resource.
Overrides:
getSize in interface Resource
Returns:
the size, as a long, 0 if the Resource does not exist (for compatibility with java.io.File), or UNKNOWN_SIZE if not known.

hashCode

public int hashCode()
Get the hash code for this Resource.
Overrides:
hashCode in interface Resource
Returns:
hash code as int.

isDirectory

public boolean isDirectory()
Tells if the resource is a directory.
Overrides:
isDirectory in interface Resource
Returns:
boolean flag indicating if the resource is a directory.

isExists

public boolean isExists()
The exists attribute tells whether a file exists.
Overrides:
isExists in interface Resource
Returns:
true if this resource exists.

isFilesystemOnly

public boolean isFilesystemOnly()
Fulfill the ResourceCollection contract.
Specified by:
isFilesystemOnly in interface ResourceCollection
Overrides:
isFilesystemOnly in interface Resource
Returns:
whether this Resource is a FileResource.

setDirectory

public void setDirectory(boolean directory)
            throws BuildException
Override setDirectory.
Overrides:
setDirectory in interface Resource
Parameters:
directory - not used.
Throws:
BuildException - always.

setExists

public void setExists(boolean exists)
Set the exists attribute.
Overrides:
setExists in interface Resource
Parameters:
exists - if true, this resource exists.

setLastModified

public void setLastModified(long lastmodified)
            throws BuildException
Override setLastModified.
Overrides:
setLastModified in interface Resource
Parameters:
lastmodified - not used.
Throws:
BuildException - always.

setName

public void setName(String name)
            throws BuildException
Overridden, not allowed to set the name of the resource.
Overrides:
setName in interface Resource
Parameters:
name - not used.
Throws:
BuildException - always.

setRefid

public void setRefid(Reference r)
Overrides the base version.
Overrides:
setRefid in interface Resource
Parameters:
r - the Reference to set.

setSize

public void setSize(long size)
            throws BuildException
Override setSize.
Overrides:
setSize in interface Resource
Parameters:
size - not used.
Throws:
BuildException - always.

toString

public String toString()
Get the string representation of this Resource.
Overrides:
toString in interface Resource
Returns:
this Resource formatted as a String.
Since:
Ant 1.7

wrapStream

protected abstract InputStream wrapStream(InputStream in)
            throws IOException
Is supposed to wrap the stream to allow decompression on the fly.
Parameters:
in - InputStream to wrap, will never be null.
Returns:
a compressed inputstream.

wrapStream

protected abstract OutputStream wrapStream(OutputStream out)
            throws IOException
Is supposed to wrap the stream to allow compression on the fly.
Parameters:
out - OutputStream to wrap, will never be null.
Returns:
a compressed outputstream.