Class CompressionUtilities
- java.lang.Object
-
- com.biomatters.geneious.publicapi.utilities.CompressionUtilities
-
public class CompressionUtilities extends java.lang.Object
Provides methods for reading from compressed files. Supported compression methods are:- Since:
- API 4.600 (Geneious 6.0.0)
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
CompressionUtilities.CompressedFileWrapper
A wrapper class for a compressed file.static class
CompressionUtilities.CompressionMethod
Represents a type of compression
-
Constructor Summary
Constructors Constructor Description CompressionUtilities()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static CompressionUtilities.CompressedFileWrapper
getCompressedFile(java.io.File file)
Returns an instance ofCompressionUtilities.CompressedFileWrapper
if the specified file contains a single compressed file.static boolean
hasGzipFileHeader(java.io.File file)
Reads the first few bytes of a file to check whether it is a Gzip file.
-
-
-
Method Detail
-
getCompressedFile
public static CompressionUtilities.CompressedFileWrapper getCompressedFile(java.io.File file)
Returns an instance ofCompressionUtilities.CompressedFileWrapper
if the specified file contains a single compressed file. Provides methods to decompress the file. Note: Will return null if the file is compressed but contains multiple files- Parameters:
file
- The file to check for compression.- Returns:
- A
CompressionUtilities.CompressedFileWrapper
or null if the specified file is not compressed or if it contains multiple compressed files
-
hasGzipFileHeader
public static boolean hasGzipFileHeader(java.io.File file)
Reads the first few bytes of a file to check whether it is a Gzip file.- Parameters:
file
- to check- Returns:
- true if file has gzip header, false if not or if there is an IOException reading the file
- Since:
- API 4.1100
-
-