Class GZipResource

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.types.DataType

org.apache.tools.ant.types.Resource

org.apache.tools.ant.types.resources.ResourceDecorator

org.apache.tools.ant.types.resources.ContentTransformingResource

org.apache.tools.ant.types.resources.CompressedResource

org.apache.tools.ant.types.resources.GZipResource

All Implemented Interfaces:

Cloneable, Comparable<Resource>, Iterable<Resource>, ResourceCollection

public class GZipResource
extends CompressedResource

A GZip compressed resource.

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

Since:

Ant 1.7

Field Summary

Fields inherited from class Resource

MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE

Modifier and Type	Field	Description
protected static final int	MAGIC	Magic number
static final long	UNKNOWN_DATETIME	Constant unknown datetime for getLastModified
static final long	UNKNOWN_SIZE	Constant unknown size

Fields inherited from class DataType

checked, ref

Modifier and Type	Field	Description
protected boolean	checked	Deprecated. since 1.7.
protected Reference	ref	Deprecated. since 1.7.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
GZipResource()	A no-arg constructor
GZipResource(ResourceCollection other)	Constructor with another resource to wrap.

Method Summary

Modifier and Type	Method	Description
protected String	getCompressionName()	Get the name of the compression method.
protected InputStream	wrapStream(InputStream in)	Decompress on the fly using java.util.zip.GZIPInputStream.
protected OutputStream	wrapStream(OutputStream out)	Compress on the fly using java.util.zip.GZIPOutStream.

Methods inherited from class CompressedResource

toString

Modifier and Type	Method	Description
String	toString()	Get the string representation of this Resource.

Methods inherited from class ContentTransformingResource

as, getInputStream, getOutputStream, getSize, isAppendSupported

Modifier and Type	Method	Description
<T> T	as(Class<T> clazz)	Suppress FileProvider, re-implement Appendable
InputStream	getInputStream()	Get an InputStream for the Resource.
OutputStream	getOutputStream()	Get an OutputStream for the Resource.
long	getSize()	Get the size of this Resource.
protected boolean	isAppendSupported()	Learn whether the transformation performed allows appends.

Methods inherited from class ResourceDecorator

addConfigured, compareTo, dieOnCircularReference, getLastModified, getName, getResource, hashCode, isDirectory, isExists, isFilesystemOnly, setDirectory, setExists, setLastModified, setName, setRefid, setSize

Modifier and Type	Method	Description
final void	addConfigured(ResourceCollection a)	Sets the resource to wrap using a single-element collection.
int	compareTo(Resource other)	Delegates to a comparison of names.
protected void	dieOnCircularReference(Stack<Object> stack, Project project)	Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
long	getLastModified()	Tells the modification time in milliseconds since 01.01.1970 .
String	getName()	Get the name of the resource.
protected final Resource	getResource()	De-references refids if any, ensures a wrapped resource has been specified.
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.

Methods inherited from class Resource

asOptional, clone, equals, getMagicNumber, getRef, iterator, size, toLongString

Modifier and Type	Method	Description
<T> Optional<T>	asOptional(Class<T> clazz)	Return Resource.as(Class) as an Optional.
Object	clone()	Clone this Resource.
boolean	equals(Object other)	Implement basic Resource equality.
protected static int	getMagicNumber(byte[] seed)	Create a "magic number" for use in hashCode calculations.
protected Resource	getRef()	Perform the check for circular references and return the referenced Resource.
Iterator<Resource>	iterator()	Fulfill the ResourceCollection contract.
int	size()	Fulfill the ResourceCollection contract.
final String	toLongString()	Get a long String representation of this Resource.

Methods inherited from class DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes

Modifier and Type	Method	Description
protected void	checkAttributesAllowed()	check that it is ok to set attributes, i.e that no reference is defined
protected void	checkChildrenAllowed()	check that it is ok to add children, i.e that no reference is defined
protected BuildException	circularReference()	Creates an exception that indicates the user has generated a loop of data types referencing each other.
protected void	dieOnCircularReference()	Convenience method.
protected void	dieOnCircularReference(Project p)	Convenience method.
protected <T> T	getCheckedRef()	Deprecated. use getCheckedRef(Class)
protected <T> T	getCheckedRef(Class<T> requiredClass)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Class<T> requiredClass, String dataTypeName, Project project)	Performs the check for circular references and returns the referenced object.
protected <T> T	getCheckedRef(Project p)	Deprecated. use getCheckedRef(Class)
protected String	getDataTypeName()	Gets as descriptive as possible a name used for this datatype instance.
Reference	getRefid()	get the reference set on this object
static void	invokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected boolean	isChecked()	The flag that is used to indicate that circular references have been checked.
boolean	isReference()	Has the refid attribute of this element been set?
protected BuildException	noChildrenAllowed()	Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
static void	pushAndInvokeCircularReferenceCheck(DataType dt, Stack<Object> stk, Project p)	Allow DataTypes outside org.apache.tools.ant.types to indirectly call dieOnCircularReference on nested DataTypes.
protected void	setChecked(boolean checked)	Set the flag that is used to indicate that circular references have been checked.
protected BuildException	tooManyAttributes()	Creates an exception that indicates that refid has to be the only attribute if it is set.

Methods inherited from class ProjectComponent

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

Modifier and Type	Method	Description
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Methods inherited from interface ResourceCollection

isEmpty, stream

Modifier and Type	Method	Description
default boolean	isEmpty()	Learn whether this ResourceCollection is empty.
default Stream<? extends Resource>	stream()	Return a Stream over this ResourceCollection.

Constructor Details

GZipResource

public GZipResource()

A no-arg constructor

GZipResource

public GZipResource(ResourceCollection other)

Constructor with another resource to wrap.

Parameters:

other - the resource to wrap.

Method Details

wrapStream

protected InputStream wrapStream(InputStream in)
                          throws IOException

Decompress on the fly using java.util.zip.GZIPInputStream.

Specified by:

wrapStream in class ContentTransformingResource

Parameters:

in - the stream to wrap.

Returns:

the wrapped stream.

Throws:

IOException - if there is a problem.

wrapStream

protected OutputStream wrapStream(OutputStream out)
                           throws IOException

Compress on the fly using java.util.zip.GZIPOutStream.

Specified by:

wrapStream in class ContentTransformingResource

Parameters:

out - the stream to wrap.

Returns:

the wrapped stream.

Throws:

IOException - if there is a problem.

getCompressionName

protected String getCompressionName()

Get the name of the compression method.

Specified by:

getCompressionName in class CompressedResource

Returns:

the string "GZip".