Libraries.Data.Compression.Decompresser Documentation

The Decompresser class can decompress files that have been compressed using zip (have the extention .zip) or gzip (have the extention .gz) compression formats. Most math functions call down to Java's java.util.zip library.

Example Code

use Libraries.System.File
    use Libraries.Data.Compression.Decompresser

    class Main
        action Main
            File inputFile
            inputFile:SetPath("zipfile.zip")

            Decompresser decompress
            decompress:DecompressZip(inputFile)
        end
    end

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
DecompressGZip(Libraries.System.File inputFile, Libraries.System.File outputFile)This decompresses a file that has been compressed using gzip compression format (has the extention .
DecompressZip(Libraries.System.File inputFile)This decompresses a file that has been compressed using zip compression format (has the extention .
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

DecompressGZip(Libraries.System.File inputFile, Libraries.System.File outputFile)

This decompresses a file that has been compressed using gzip compression format (has the extention .gz).

Example Code

use Libraries.System.File
    use Libraries.Data.Compression.Decompresser

    class Main
        action Main
            File inputFile
            inputFile:SetPath("gzipfile.txt.gz")

            File outputFile
            outputFile:SetPath("gzipfile.txt")

            Decompresser decompress
            decompress:DecompressGZip(inputFile, outputFile)
        end
    end

Parameters

DecompressZip(Libraries.System.File inputFile)

This decompresses a file that has been compressed using zip compression format (has the extention .zip).

Example Code

use Libraries.System.File
    use Libraries.Data.Compression.Decompresser

    class Main
        action Main
            File inputFile
            inputFile:SetPath("zipfile.zip")

            Decompresser decompress
            decompress:DecompressZip(inputFile)
        end
    end

Parameters

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.