Package org.opentrafficsim.base.compressedfiles

Enum CompressionType

java.lang.Object

java.lang.Enum<CompressionType>

org.opentrafficsim.base.compressedfiles.CompressionType

All Implemented Interfaces:

Serializable, Comparable<CompressionType>, java.lang.constant.Constable

public enum CompressionType
extends Enum<CompressionType>

Types of compression supported by the compressed file writers and readers.

Copyright (c) 2013-2019 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

Version:

$Revision$, $LastChangedDate$, by $Author$, initial version Oct 24, 2018

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTODETECT	Auto-detect the compression method (only for readers).
BZIP2	Create or read a bzip2-compressed file.
GZIP	Create or read a gzip-compressed file.
NONE	Do not compress / uncompress the data.
ZIP	Create or read a ZIP archive with one, top-level entry in the TOC.

Method Summary

Modifier and Type	Method	Description
String	getExtension()	Retrieve the commonly used file extension for files containing data that is compressed using this method.
static CompressionType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CompressionType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final CompressionType NONE

Do not compress / uncompress the data.

ZIP

public static final CompressionType ZIP

Create or read a ZIP archive with one, top-level entry in the TOC.

GZIP

public static final CompressionType GZIP

Create or read a gzip-compressed file.

BZIP2

public static final CompressionType BZIP2

Create or read a bzip2-compressed file.

AUTODETECT

public static final CompressionType AUTODETECT

Auto-detect the compression method (only for readers).

Method Details

values

public static CompressionType[] values()

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

Returns:

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

valueOf

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

getExtension

public String getExtension()

Retrieve the commonly used file extension for files containing data that is compressed using this method.

Returns:

String; the commonly used file extension for files containing data that is compressed using this method