[
https://issues.apache.org/jira/browse/COMPRESS-217?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Gili updated COMPRESS-217:
--------------------------
Component/s: (was: Archivers)
Documentation
Compressors
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.
# Please clarify the difference between Archive and Compressor classes
# Please mention that CompressorStreamFactory.createCompressorInputStream() can
also be used to auto-detect the input format of a stream.
was:ArchiveStreamFactory.createArchiveInputStream() should invoke
GzipCompressorInputStream.matches() to check if the InputStream is a GZip file.
Right now if a GZip file is passed in, the method fails with "No Archiver found
for the stream signature".
Summary: Documentation should provide example of
CompressorStreamFactory.createCompressorInputStream() (was:
ArchiveStreamFactory.createArchiveInputStream() should check for GZip format)
> Documentation should provide example of
> CompressorStreamFactory.createCompressorInputStream()
> ---------------------------------------------------------------------------------------------
>
> Key: COMPRESS-217
> URL: https://issues.apache.org/jira/browse/COMPRESS-217
> Project: Commons Compress
> Issue Type: Improvement
> Components: Compressors, Documentation
> Affects Versions: 1.4.1
> Reporter: Gili
> Original Estimate: 1h
> Remaining Estimate: 1h
>
> 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.
> # Please clarify the difference between Archive and Compressor classes
> # Please mention that CompressorStreamFactory.createCompressorInputStream()
> can also be used to auto-detect the input format of a stream.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
