You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "Stefan Bodewig (JIRA)" <ji...@apache.org> on 2013/03/03 16:37:12 UTC

[jira] [Resolved] (COMPRESS-217) Documentation should provide example of CompressorStreamFactory.createCompressorInputStream()

     [ https://issues.apache.org/jira/browse/COMPRESS-217?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Stefan Bodewig resolved COMPRESS-217.
-------------------------------------

       Resolution: Fixed
    Fix Version/s: 1.5

fixed in svn trunk with revision 1452054 - should hopefully become visible on the webiste soon.
                
> 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
>             Fix For: 1.5
>
>   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