StreamCompression (dxlib 3.341)

java.lang.Object
- com.devexperts.io.StreamCompression

```
public final class StreamCompression
extends Object
```
Defines byte stream compression format.
Supported compression formats are:

Name Mime type Extension File magic bytes Sync flush

NONE null Yes

GZIP application/gzip .gz 0x1f8b Yes

ZIP application/zip .zip 0x504b0304 Yes

NONE compression format serves as a null object and does not do anything.

Name	`Mime type`	`Extension`	File magic bytes	`Sync flush`
`NONE`	`null`			Yes
`GZIP`	application/gzip	.gz	0x1f8b	Yes
`ZIP`	application/zip	.zip	0x504b0304	Yes

Field Summary

Fields
Modifier and Type	Field and Description
`static StreamCompression`	`GZIP` Gzip compression format.
`static StreamCompression`	`NONE` No compression.
`static StreamCompression`	`ZIP` Zip compression format.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OutputStream`	`compress(OutputStream out, String name)` Compresses the given output stream with this compression format.
`InputStream`	`decompress(InputStream in)` Decompresses the given input stream with this compression format.
`static StreamCompression`	`detectCompressionByExtension(String fileName)` Detects compression format by the extension at the end of the file name.
`static StreamCompression`	`detectCompressionByHeader(InputStream in)` Detects compression format by the magic number in the file header.
`static InputStream`	`detectCompressionByHeaderAndDecompress(InputStream in)` Detects compression format by the magic number in the file header and decompresses the given input stream.
`static StreamCompression`	`detectCompressionByMimeType(String mimeType)` Detects compression format by the mime type.
`boolean`	`equals(Object o)` Indicates whether some other object is "equal to" this one.
`String`	`getExtension()` Return file name extension of this compression format.
`String`	`getMimeType()` Return mime type of this compression format.
`int`	`hashCode()` Returns a hash code value for the object.
`boolean`	`hasSyncFlush()` Returns true if this compression format can be used for live data streams.
`String`	`stripExtension(String fileName)` Strips extension of this compression format from the end of the file if it matches.
`String`	`toString()` Returns a string representation of the stream compression type.
`static StreamCompression`	`valueOf(String value)` Parses stream compression format description from string.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - NONE
```
public static final StreamCompression NONE
```
    No compression.
  - GZIP
```
public static final StreamCompression GZIP
```
    Gzip compression format.
  - ZIP
```
public static final StreamCompression ZIP
```
    Zip compression format.
- Method Detail
  - valueOf
```
public static StreamCompression valueOf(String value)
```
    Parses stream compression format description from string. The string can contain (ignoring case): "none" for NONE, "gzip" for GZIP, or "zip" for ZIP. The last two can be optionally followed by "[level=X]", where X is a number from 0 to 9 (inclusive) specifying desired compression level which takes effect during compression.
    This method can reverse the result oftoString() method.
    
    Returns:
    
    stream compression format.
    
    Throws:
    
    NullPointerException - if value is null.
    
    InvalidFormatException - if value is not a supported compression type string.
  - detectCompressionByMimeType
```
public static StreamCompression detectCompressionByMimeType(String mimeType)
```
    Detects compression format by the mime type.
    
    Parameters:
    
    mimeType - the mime type.
    
    Returns:
    
    detected compression format or NONE is the mime type is not recognized.
    
    Throws:
    
    NullPointerException - if mimeType is null.
  - detectCompressionByExtension
```
public static StreamCompression detectCompressionByExtension(String fileName)
```
    Detects compression format by the extension at the end of the file name.
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    detected compression format or NONE is the file name extension is not recognized.
    
    Throws:
    
    NullPointerException - if fileName is null.
  - detectCompressionByHeader
```
public static StreamCompression detectCompressionByHeader(InputStream in)
                                                   throws IOException
```
    Detects compression format by the magic number in the file header. This method marks the stream, read first 4 bytes, and resets the stream to an original state.
    
    Parameters:
    
    in - the input stream.
    
    Returns:
    
    detected compression format or NONE is the header is not recognized.
    
    Throws:
    
    IOException - if an I/O error occurs.
    
    IllegalArgumentException - if in does not support mark.
  - detectCompressionByHeaderAndDecompress
```
public static InputStream detectCompressionByHeaderAndDecompress(InputStream in)
                                                          throws IOException
```
    Detects compression format by the magic number in the file header and decompresses the given input stream. This method wraps the input stream in BufferedInputStream if the original stream does not support mark before using detectCompressionByHeader method.
    
    Parameters:
    
    in - the input stream.
    
    Returns:
    
    the decompressed stream.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - getMimeType
```
public String getMimeType()
```
    Return mime type of this compression format. The result is null for NONE, "application/gzip" for GZIP, and "application/zip" for ZIP.
    
    Returns:
    
    mime type extension string.
  - getExtension
```
public String getExtension()
```
    Return file name extension of this compression format. The result is "" (empty string) for NONE, ".gz" for GZIP, and ".zip" for ZIP.
    
    Returns:
    
    file name extension string.
  - stripExtension
```
public String stripExtension(String fileName)
```
    Strips extension of this compression format from the end of the file if it matches.
    
    Parameters:
    
    fileName - the file name.
    
    Returns:
    
    the file name without extension of this compression format or an original file name otherwise.
    
    Throws:
    
    NullPointerException - if fileName is null.
  - hasSyncFlush
```
public boolean hasSyncFlush()
```
    Returns true if this compression format can be used for live data streams.
    
    Returns:
    
    true if this compression format can be used for live data streams.
  - decompress
```
public InputStream decompress(InputStream in)
                       throws IOException
```
    Decompresses the given input stream with this compression format.
    
    Parameters:
    
    in - the input stream.
    
    Returns:
    
    the decompressed stream or an original stream if this compression format is NONE.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - compress
```
public OutputStream compress(OutputStream out,
                             String name)
                      throws IOException
```
    Compresses the given output stream with this compression format.
    
    Parameters:
    
    out - the output stream.
    
    name - the name of the file that is being compressed. It is used by ZIP compression format.
    
    Returns:
    
    the compressed stream or an original stream if this compression format is NONE.
    
    Throws:
    
    IOException - if an I/O error occurs.
  - toString
```
public String toString()
```
    Returns a string representation of the stream compression type. It is represented in lower-case.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    a string representation of the stream compression type.
  - equals
```
public boolean equals(Object o)
```
    Indicates whether some other object is "equal to" this one.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    o - the reference object with which to compare.
    
    Returns:
    
    true if this object is the same as the obj argument; false otherwise.
  - hashCode
```
public int hashCode()
```
    Returns a hash code value for the object.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    a hash code value for this object.

Class StreamCompression

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NONE

GZIP

ZIP

Method Detail

valueOf

detectCompressionByMimeType

detectCompressionByExtension

detectCompressionByHeader

detectCompressionByHeaderAndDecompress

getMimeType

getExtension

stripExtension

hasSyncFlush

decompress

compress

toString

equals

hashCode