[jira] [Resolved] (COMPRESS-202) Document EOF behavior of TarArchiveInputStream

["Stefan Bodewig (JIRA)" <ji...@apache.org>]

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

Stefan Bodewig resolved COMPRESS-202.
-------------------------------------

       Resolution: Fixed
    Fix Version/s: 1.5

Documentation added with svn revision 1435897 but it hasn't been published to the website, yet.  The 1.5 notes are a lie right now as they say what is planned rather than what is implemented already.
                
> Document EOF behavior of TarArchiveInputStream
> ----------------------------------------------
>
>                 Key: COMPRESS-202
>                 URL: https://issues.apache.org/jira/browse/COMPRESS-202
>             Project: Commons Compress
>          Issue Type: Wish
>          Components: Documentation
>            Reporter: Paul Burrowes
>            Priority: Minor
>             Fix For: 1.5
>
>
> When reading from a tar stream getNextEntry() returns null to signify EOF after reading the first EOF record. This leaves the second EOF record in the stream unread potentially confusing subsequent readers or blocking the writer trying to flush the stream in a piped configuration e.g. network streaming.
> The solution to this is to, if you care about subsequent data or true EOF, read from the underlying InputStream until EOF or a protocol record marker.
> It would be nice to have the documentation of TarArchiveInputStream mention that it does not read the stream fully but stops at the first EOF record.

--
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