Package org.opentrafficsim.base.compressedfiles

Enum CompressionType

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CompressionType>
    public enum CompressionType
extends java.lang.Enum<CompressionType>
    Types of compression supported by the compressed file writers and readers.

    Copyright (c) 2013-2020 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

    • 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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getExtension()
      Retrieve the commonly used file extension for files containing data that is compressed using this method.
      static CompressionType valueOf​(java.lang.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, 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 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 Detail

      • values

        public static CompressionType[] 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 (CompressionType c : CompressionType.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static CompressionType valueOf​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getExtension

        public java.lang.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