public
final
enum
ArchiveFormat
extends Enum<E extends Enum<E>>| java.lang.Object | ||
| ↳ | java.lang.Enum<E extends java.lang.Enum<E>> | |
| ↳ | com.atlassian.bitbucket.content.ArchiveFormat | |
Class Overview
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.
Summary
| Enum Values | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ArchiveFormat | TAR | Streams the archive as an uncompressed tarball. | |||||||||
| ArchiveFormat | TAR_GZ | Streams the archive as a GZip-compressed tarball. | |||||||||
| ArchiveFormat | ZIP | Streams the archive as a zip file, using the default compression level for the SCM. | |||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Searches for the format which produces the provided
extension, case-insensitively. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Enum
| |||||||||||
|
From class
java.lang.Object
| |||||||||||
|
From interface
java.lang.Comparable
| |||||||||||
Enum Values
public static final ArchiveFormat ZIP
Streams the archive as a zip file, using the default compression level for the SCM.
Public Methods
@Nonnull public static ArchiveFormat fromExtension (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 |
|---|
@Nonnull public String getDefaultExtension ()
Returns
- the default extension for this format
@Nonnull public Set<String> getExtensions ()
Returns
- a set containing one or more extensions which are commonly used with this format