com.github.gekomad.scalacompress

Compressors

object Compressors

Compressors

Since

0.0.1

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Compressors
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class StreamCompress(compressorName: StreamableCompressor, out: OutputStream) extends Product with Serializable

  2. case class StreamDecompress(compressorName: StreamableCompressor, in: InputStream) extends Product with Serializable

    Decompressing stream example

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object StreamableCompressor extends Enumeration

  7. def arCompress(src: List[String], dest: String): Try[CompressionStats]

    src

    File and folder to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  8. def arDecompress(src: String, dest: String, entries: Option[List[String]] = None): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    entries

    If != None extract only these entries

    returns

    Statistics on decompression procedure

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def bzip2Compress(src: String, dest: String): Try[CompressionStats]

    src

    File to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  11. def bzip2Decompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )

  13. def compressStream(compressorName: StreamableCompressor, in: InputStream, out: OutputStream): Try[Unit] 

    val in: InputStream     = ???
val out: OutputStream   = ???
val compress: Try[Unit] = compressStream(StreamableCompressor.GZ, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.DEFLATE, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.BZ2, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.PACK200, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.XZ, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.ZSTANDARD, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.LZMA, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.LZ4, in, out)
//    val compress: Try[Unit] = compressStream(StreamableCompressor.SNAPPY, in, out)
    compressorName
    in
    out
    returns

  14. def cpioCompress(src: List[String], dest: String): Try[CompressionStats]

    src

    File and folder to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  15. def cpioDecompress(src: String, dest: String, entries: Option[List[String]] = None): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    entries

    If != None extract only these entries

    returns

    Statistics on decompression procedure

  16. def decompressStream(compressorName: StreamableCompressor, in: InputStream, out: OutputStream): Try[Unit] 

    val in: InputStream = ???
val out: OutputStream = ???
val decompress: Try[Unit] = decompressStream(StreamableCompressor.GZ,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.DEFLATE,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.BZ2,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.PACK200,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.XZ,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.ZSTANDARD,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.LZMA,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.LZ4,in, out)
//    val decompress: Try[Unit] = decompressStream(StreamableCompressor.SNAPPY,in, out)
    compressorName
    in
    out
    returns

  17. def deflateCompress(src: String, dest: String): Try[CompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  18. def deflateDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  20. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  22. def gzCompress(src: String, dest: String): Try[CompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  23. def gzDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  24. def hashCode(): Int

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def lz4Compress(src: String, dest: String): Try[CompressionStats]

    src

    file to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  27. def lz4Decompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  28. def lzmaCompress(src: String, dest: String): Try[CompressionStats]

    src

    file to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  29. def lzmaDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  30. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  31. final def notify(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  32. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()

  33. def pack200Compress(src: String, dest: String): Try[CompressionStats]

    src

    File to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  34. def pack200Decompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  35. def sevenZipCompress(src: List[String], dest: String): Try[CompressionStats]

    src

    File and folder to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  36. def sevenZipDecompress(src: String, dest: String, entries: Option[List[String]] = None): Try[DecompressionStats]

    src

    Compressed file

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  37. def snappyCompress(src: String, dest: String): Try[CompressionStats]

    src

    File to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  38. def snappyDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  39. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  40. def tarCompress(src: List[String], dest: String): Try[CompressionStats]

    src

    File and folder to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  41. def tarDecompress(src: String, dest: String, entries: Option[List[String]] = None): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    entries

    If != None extract only these entries

    returns

    Statistics on decompression procedure

  42. def toString(): String

    Definition Classes
    AnyRef → Any

  43. def unzipString(src: Array[Byte], bufferSize: Int = 256): Try[Array[Byte]]

    src

    Compressed Array[Byte]

    bufferSize

    Optional buffer size

    returns

    Uncompressed Array[Byte]

  44. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  45. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. def writeStreamToFile(in: InputStream, dest: String): Try[Unit]

  48. def xzCompress(src: String, dest: String): Try[CompressionStats]

    src

    File to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  49. def xzDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  50. def zStandardCompress(src: String, dest: String): Try[CompressionStats]

    src

    File to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  51. def zStandardDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  52. def zipCompress(src: List[String], dest: String): Try[CompressionStats]

    src

    File and folder to compress

    dest

    Destination folder

    returns

    Statistics on compression procedure

  53. def zipDecompress(src: String, dest: String): Try[DecompressionStats]

    src

    File to decompress

    dest

    Destination folder

    returns

    Statistics on decompression procedure

  54. def zipDecompressEntry(src: String, entryName: String): Try[Array[Byte]]

    src

    Compressed file

    entryName

    The entry name to decompress

    returns

    Uncompressed Array[Byte]

  55. def zipEntries(src: String): Try[List[ZipEntry]]

    src

    Compressed file

    returns

    ZipEntry List

  56. def zipString(src: String, charSetName: String = "UTF-8"): Try[Array[Byte]]

    src

    String to compress

    charSetName
    returns

    compressed Array[Byte]

Deprecated Value Members

  1. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from AnyRef

Inherited from Any

Ungrouped