Uploaded image for project: 'Commons Compress'
  1. Commons Compress
  2. COMPRESS-217

Documentation should provide example of CompressorStreamFactory.createCompressorInputStream()

    XMLWordPrintableJSON

Details

    • Improvement
    • Status: Resolved
    • Major
    • Resolution: Fixed
    • 1.4.1
    • 1.5
    • Compressors, Documentation
    • None

    Description

      The documentation found at http://commons.apache.org/compress/examples.html should explain the difference between Archive and Compressor classes. Currently the only example for making a "factory guess the input format for a given stream" uses ArchiveStreamFactory but in actuality CompressorStreamFactory.createCompressorInputStream() will do the same for file formats like gzip. Without further clarification it sounds like ArchiveStreamFactory is only used for decompressing and CompressorStreamFactory is only used for compressing.

      1. Please clarify the difference between Archive and Compressor classes
      2. Please mention that CompressorStreamFactory.createCompressorInputStream() can also be used to auto-detect the input format of a stream.

      Attachments

        Activity

          People

            Unassigned Unassigned
            cowwoc Gili
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - 1h
                1h
                Remaining:
                Remaining Estimate - 1h
                1h
                Logged:
                Time Spent - Not Specified
                Not Specified