hudson
Enum FilePath.TarCompression

java.lang.Object
  java.lang.Enum<FilePath.TarCompression>
      hudson.FilePath.TarCompression

All Implemented Interfaces:

Serializable, Comparable<FilePath.TarCompression>

Enclosing class:

FilePath

public static enum FilePath.TarCompression
extends Enum<FilePath.TarCompression>

Supported tar file compression methods.

Enum Constant Summary

GZIP

NONE

Method Summary

abstract OutputStream	compress(OutputStream in)
abstract InputStream	extract(InputStream in)
static FilePath.TarCompression	valueOf(String name) Returns the enum constant of this type with the specified name.
static FilePath.TarCompression[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FilePath.TarCompression NONE

GZIP

public static final FilePath.TarCompression GZIP

Method Detail

values

public static FilePath.TarCompression[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FilePath.TarCompression c : FilePath.TarCompression.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FilePath.TarCompression valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

extract

public abstract InputStream extract(InputStream in)
                             throws IOException

Throws:

IOException

compress

public abstract OutputStream compress(OutputStream in)
                               throws IOException

Throws:

IOException