| Prev Class | Next Class | Frames | No Frames |
| Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Objectorg.apache.tools.ant.ProjectComponentorg.apache.tools.ant.types.DataTypeorg.apache.tools.ant.types.Resourceorg.apache.tools.ant.types.resources.CompressedResourcepublic abstract class CompressedResourceextends ResourceField Summary |
Fields inherited from class org.apache.tools.ant.types.Resource | |
MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE | |
Fields inherited from class org.apache.tools.ant.ProjectComponent | |
description, location, project | |
Constructor Summary | |
| |
| |
Method Summary | |
void |
|
int |
|
protected abstract String | |
InputStream |
|
long |
|
String |
|
OutputStream |
|
long |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
void |
|
void |
|
void |
|
void |
|
void | |
void |
|
String |
|
protected abstract InputStream |
|
protected abstract OutputStream |
|
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 | |
public CompressedResource()
no arg constructor
public CompressedResource(ResourceCollection other)
Constructor with another resource to wrap.
- Parameters:
other- the resource to wrap.
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.
public int compareTo(Object other)
Delegates to a comparison of names.
- 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.
protected abstract String getCompressionName()
- Returns:
- the name of the compression method.
public InputStream getInputStream()
throws IOExceptionGet an InputStream for the Resource.
- Overrides:
- getInputStream in interface Resource
- Returns:
- an InputStream containing this Resource's content.
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.
public String getName()
Get the name of the resource.
- Returns:
- the name of the wrapped resource.
public OutputStream getOutputStream()
throws IOExceptionGet an OutputStream for the Resource.
- Overrides:
- getOutputStream in interface Resource
- Returns:
- an OutputStream to which content can be written.
public long getSize()
Get the size of this 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.
public int hashCode()
Get the hash code for this Resource.
- Returns:
- hash code as int.
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.
public boolean isExists()
The exists attribute tells whether a file exists.
- Returns:
- true if this resource exists.
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.
public void setDirectory(boolean directory)
throws BuildExceptionOverride setDirectory.
- Overrides:
- setDirectory in interface Resource
- Parameters:
directory- not used.
- Throws:
BuildException- always.
public void setExists(boolean exists)
Set the exists attribute.
- Parameters:
exists- if true, this resource exists.
public void setLastModified(long lastmodified)
throws BuildExceptionOverride setLastModified.
- Overrides:
- setLastModified in interface Resource
- Parameters:
lastmodified- not used.
- Throws:
BuildException- always.
public void setName(String name)
throws BuildExceptionOverridden, not allowed to set the name of the resource.
- Parameters:
name- not used.
- Throws:
BuildException- always.
public void setRefid(Reference r)
Overrides the base version.
- Parameters:
r- the Reference to set.
public void setSize(long size)
throws BuildExceptionOverride setSize.
- Parameters:
size- not used.
- Throws:
BuildException- always.
public String toString()
Get the string representation of this Resource.
- Returns:
- this Resource formatted as a String.
- Since:
- Ant 1.7
protected abstract InputStream wrapStream(InputStream in)
throws IOExceptionIs supposed to wrap the stream to allow decompression on the fly.
- Parameters:
in- InputStream to wrap, will never be null.
- Returns:
- a compressed inputstream.
protected abstract OutputStream wrapStream(OutputStream out)
throws IOExceptionIs supposed to wrap the stream to allow compression on the fly.
- Parameters:
out- OutputStream to wrap, will never be null.
- Returns:
- a compressed outputstream.