com.atlassian.bitbucket.content

Enum ArchiveFormat

java.lang.Object

java.lang.Enum<ArchiveFormat>

com.atlassian.bitbucket.content.ArchiveFormat

All Implemented Interfaces:

Serializable, Comparable<ArchiveFormat>

public enum ArchiveFormat
extends Enum<ArchiveFormat>

Describes the different formats archives may be streamed in.

Individual SCMs may support additional formats, but any SCM which advertizes the archive feature is required to support all of these formats. Using any other format requires referencing the SCM directly.

Since:

5.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
TAR Streams the archive as an uncompressed tarball.
TAR_GZ Streams the archive as a GZip-compressed tarball.
ZIP Streams the archive as a zip file, using the default compression level for the SCM.

Method Summary

Modifier and Type	Method and Description
static ArchiveFormat	fromExtension(String extension) Searches for the format which produces the provided extension, case-insensitively.
String	getDefaultExtension()
Set<String>	getExtensions()
static ArchiveFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static ArchiveFormat[]	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

TAR

public static final ArchiveFormat TAR

Streams the archive as an uncompressed tarball.

TAR_GZ

public static final ArchiveFormat TAR_GZ

Streams the archive as a GZip-compressed tarball.

ZIP

public static final ArchiveFormat ZIP

Streams the archive as a zip file, using the default compression level for the SCM.

Method Detail

values

public static ArchiveFormat[] 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 (ArchiveFormat c : ArchiveFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static ArchiveFormat 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

fromExtension

@Nonnull
public static ArchiveFormat fromExtension(@Nonnull
                                                   String extension)

Searches for the format which produces the provided extension, case-insensitively.

Parameters:

extension - the extension to search for

Returns:

the format which produces the provided extension

Throws:

IllegalArgumentException - if no format produces the requested extension

getDefaultExtension

@Nonnull
public String getDefaultExtension()

Returns:

the default extension for this format

getExtensions

@Nonnull
public Set<String> getExtensions()

Returns:

a set containing one or more extensions which are commonly used with this format