Class Untar.UntarCompressionMethod

java.lang.Object

org.apache.tools.ant.types.EnumeratedAttribute

org.apache.tools.ant.taskdefs.Untar.UntarCompressionMethod

Enclosing class:

Untar

public static final class Untar.UntarCompressionMethod
extends EnumeratedAttribute

Valid Modes for Compression attribute to Untar Task

Since:

Ant 1.1

Field Summary

Fields inherited from class EnumeratedAttribute

value

Modifier and Type	Field	Description
protected String	value	The selected value in this enumeration.

Constructor Summary

Constructors

Constructor	Description
UntarCompressionMethod()	Constructor

Method Summary

Modifier and Type	Method	Description
InputStream	decompress(String name, InputStream istream)	This method wraps the input stream with the corresponding decompression method
String[]	getValues()	Get valid enumeration values

Methods inherited from class EnumeratedAttribute

containsValue, getIndex, getInstance, getValue, indexOfValue, setValue, toString

Modifier and Type	Method	Description
final boolean	containsValue(String value)	Is this value included in the enumeration?
final int	getIndex()
static EnumeratedAttribute	getInstance(Class<? extends EnumeratedAttribute> clazz, String value)	Factory method for instantiating EAs via API in a more developer friendly way.
final String	getValue()
final int	indexOfValue(String value)	get the index of a value in this enumeration.
void	setValue(String value)	Invoked by IntrospectionHelper.
String	toString()	Convert the value to its string form.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

UntarCompressionMethod

public UntarCompressionMethod()

Constructor

Method Details

getValues

public String[] getValues()

Get valid enumeration values

Specified by:

getValues in class EnumeratedAttribute

Returns:

valid values

decompress

public InputStream decompress(String name,
 InputStream istream)
                       throws IOException,
BuildException

This method wraps the input stream with the corresponding decompression method

Parameters:

name - provides location information for BuildException

istream - input stream

Returns:

input stream with on-the-fly decompression

Throws:

IOException - thrown by GZIPInputStream constructor

BuildException - thrown if bzip stream does not start with expected magic values