[jira] [Created] (IO-554) copyToFile(InputStream source, File destination) closes input stream
Michele Mariotti created IO-554:
---
Summary: copyToFile(InputStream source, File destination) closes
input stream
Key: IO-554
URL: https://issues.apache.org/jira/browse/IO-554
Project: Commons IO
Issue Type: Bug
Components: Streams/Writers
Affects Versions: 2.6
Reporter: Michele Mariotti
Priority: Blocker
Fix For: 2.7
In 2.6 this method is closing the input stream, while the javadoc states the
opposite.
The correct behavior is to leave the stream open, as stated in the javadoc.
I assigned a high priority because this incorrect behavior breaks existing
code, especially when used in combination with ZipInputStream.
{code:java}
/**
* Copies bytes from an {@link InputStream} source to a file
* destination. The directories up to destination
* will be created if they don't already exist. destination
* will be overwritten if it already exists.
* The {@code source} stream is left open, e.g. for use with {@link
java.util.zip.ZipInputStream ZipInputStream}.
* See {@link #copyInputStreamToFile(InputStream, File)} for a method that
closes the input stream.
*
* @param source the InputStream to copy bytes from, must not
be {@code null}
* @param destination the non-directory File to write bytes to
*(possibly overwriting), must not be {@code null}
* @throws IOException if destination is a directory
* @throws IOException if destination cannot be written
* @throws IOException if destination needs creating but can't be
* @throws IOException if an IO error occurs during copying
* @since 2.5
*/
public static void copyToFile(final InputStream source, final File destination)
throws IOException {
try (InputStream in = source;
OutputStream out = openOutputStream(destination)) {
IOUtils.copy(in, out);
}
}
{code}
instead it should be:
{code:java}
public static void copyToFile(final InputStream source, final File destination)
throws IOException {
try (OutputStream out = openOutputStream(destination)) {
IOUtils.copy(source, out);
}
}{code}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Updated] (IO-554) FileUtils.copyToFile(InputStream source, File destination) closes input stream
[
https://issues.apache.org/jira/browse/IO-554?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michele Mariotti updated IO-554:
Summary: FileUtils.copyToFile(InputStream source, File destination) closes
input stream (was: copyToFile(InputStream source, File destination) closes
input stream)
> FileUtils.copyToFile(InputStream source, File destination) closes input stream
> --
>
> Key: IO-554
> URL: https://issues.apache.org/jira/browse/IO-554
> Project: Commons IO
> Issue Type: Bug
> Components: Streams/Writers
>Affects Versions: 2.6
>Reporter: Michele Mariotti
>Priority: Blocker
> Labels: regression
> Fix For: 2.7
>
>
> In 2.6 this method is closing the input stream, while the javadoc states the
> opposite.
> The correct behavior is to leave the stream open, as stated in the javadoc.
> I assigned a high priority because this incorrect behavior breaks existing
> code, especially when used in combination with ZipInputStream.
> {code:java}
> /**
> * Copies bytes from an {@link InputStream} source to a file
> * destination. The directories up to destination
> * will be created if they don't already exist. destination
> * will be overwritten if it already exists.
> * The {@code source} stream is left open, e.g. for use with {@link
> java.util.zip.ZipInputStream ZipInputStream}.
> * See {@link #copyInputStreamToFile(InputStream, File)} for a method that
> closes the input stream.
> *
> * @param source the InputStream to copy bytes from, must
> not be {@code null}
> * @param destination the non-directory File to write bytes to
> *(possibly overwriting), must not be {@code null}
> * @throws IOException if destination is a directory
> * @throws IOException if destination cannot be written
> * @throws IOException if destination needs creating but can't be
> * @throws IOException if an IO error occurs during copying
> * @since 2.5
> */
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (InputStream in = source;
>OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(in, out);
> }
> }
> {code}
> instead it should be:
> {code:java}
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(source, out);
> }
> }{code}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (IO-554) FileUtils.copyToFile(InputStream source, File destination) closes input stream
[
https://issues.apache.org/jira/browse/IO-554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16239466#comment-16239466
]
Michele Mariotti commented on IO-554:
-
Created Pull Request [#49|https://github.com/apache/commons-io/pull/49].
Glad to help :)
> FileUtils.copyToFile(InputStream source, File destination) closes input stream
> --
>
> Key: IO-554
> URL: https://issues.apache.org/jira/browse/IO-554
> Project: Commons IO
> Issue Type: Bug
> Components: Streams/Writers
>Affects Versions: 2.6
>Reporter: Michele Mariotti
>Assignee: Bruno P. Kinoshita
>Priority: Blocker
> Labels: regression
> Fix For: 2.7
>
>
> In 2.6 this method is closing the input stream, while the javadoc states the
> opposite.
> The correct behavior is to leave the stream open, as stated in the javadoc.
> I assigned a high priority because this incorrect behavior breaks existing
> code, especially when used in combination with ZipInputStream.
> {code:java}
> /**
> * Copies bytes from an {@link InputStream} source to a file
> * destination. The directories up to destination
> * will be created if they don't already exist. destination
> * will be overwritten if it already exists.
> * The {@code source} stream is left open, e.g. for use with {@link
> java.util.zip.ZipInputStream ZipInputStream}.
> * See {@link #copyInputStreamToFile(InputStream, File)} for a method that
> closes the input stream.
> *
> * @param source the InputStream to copy bytes from, must
> not be {@code null}
> * @param destination the non-directory File to write bytes to
> *(possibly overwriting), must not be {@code null}
> * @throws IOException if destination is a directory
> * @throws IOException if destination cannot be written
> * @throws IOException if destination needs creating but can't be
> * @throws IOException if an IO error occurs during copying
> * @since 2.5
> */
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (InputStream in = source;
>OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(in, out);
> }
> }
> {code}
> instead it should be:
> {code:java}
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(source, out);
> }
> }{code}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (IO-554) FileUtils.copyToFile(InputStream source, File destination) closes input stream
[
https://issues.apache.org/jira/browse/IO-554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16239495#comment-16239495
]
Michele Mariotti commented on IO-554:
-
test case added
> FileUtils.copyToFile(InputStream source, File destination) closes input stream
> --
>
> Key: IO-554
> URL: https://issues.apache.org/jira/browse/IO-554
> Project: Commons IO
> Issue Type: Bug
> Components: Streams/Writers
>Affects Versions: 2.6
>Reporter: Michele Mariotti
>Assignee: Bruno P. Kinoshita
>Priority: Blocker
> Labels: regression
> Fix For: 2.7
>
>
> In 2.6 this method is closing the input stream, while the javadoc states the
> opposite.
> The correct behavior is to leave the stream open, as stated in the javadoc.
> I assigned a high priority because this incorrect behavior breaks existing
> code, especially when used in combination with ZipInputStream.
> {code:java}
> /**
> * Copies bytes from an {@link InputStream} source to a file
> * destination. The directories up to destination
> * will be created if they don't already exist. destination
> * will be overwritten if it already exists.
> * The {@code source} stream is left open, e.g. for use with {@link
> java.util.zip.ZipInputStream ZipInputStream}.
> * See {@link #copyInputStreamToFile(InputStream, File)} for a method that
> closes the input stream.
> *
> * @param source the InputStream to copy bytes from, must
> not be {@code null}
> * @param destination the non-directory File to write bytes to
> *(possibly overwriting), must not be {@code null}
> * @throws IOException if destination is a directory
> * @throws IOException if destination cannot be written
> * @throws IOException if destination needs creating but can't be
> * @throws IOException if an IO error occurs during copying
> * @since 2.5
> */
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (InputStream in = source;
>OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(in, out);
> }
> }
> {code}
> instead it should be:
> {code:java}
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(source, out);
> }
> }{code}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
[jira] [Commented] (IO-554) FileUtils.copyToFile(InputStream source, File destination) closes input stream
[
https://issues.apache.org/jira/browse/IO-554?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16239595#comment-16239595
]
Michele Mariotti commented on IO-554:
-
There is already a method which closes the input stream: it is
FileUtils.copyInputStreamToFile.
The only difference between methods is the closure of input stream.
However, I agree that the method names are an unhappy choice and that should be
renamed to something more meaningful.
> FileUtils.copyToFile(InputStream source, File destination) closes input stream
> --
>
> Key: IO-554
> URL: https://issues.apache.org/jira/browse/IO-554
> Project: Commons IO
> Issue Type: Bug
> Components: Streams/Writers
>Affects Versions: 2.6
>Reporter: Michele Mariotti
>Assignee: Bruno P. Kinoshita
>Priority: Blocker
> Labels: regression
> Fix For: 2.7
>
>
> In 2.6 this method is closing the input stream, while the javadoc states the
> opposite.
> The correct behavior is to leave the stream open, as stated in the javadoc.
> I assigned a high priority because this incorrect behavior breaks existing
> code, especially when used in combination with ZipInputStream.
> {code:java}
> /**
> * Copies bytes from an {@link InputStream} source to a file
> * destination. The directories up to destination
> * will be created if they don't already exist. destination
> * will be overwritten if it already exists.
> * The {@code source} stream is left open, e.g. for use with {@link
> java.util.zip.ZipInputStream ZipInputStream}.
> * See {@link #copyInputStreamToFile(InputStream, File)} for a method that
> closes the input stream.
> *
> * @param source the InputStream to copy bytes from, must
> not be {@code null}
> * @param destination the non-directory File to write bytes to
> *(possibly overwriting), must not be {@code null}
> * @throws IOException if destination is a directory
> * @throws IOException if destination cannot be written
> * @throws IOException if destination needs creating but can't be
> * @throws IOException if an IO error occurs during copying
> * @since 2.5
> */
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (InputStream in = source;
>OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(in, out);
> }
> }
> {code}
> instead it should be:
> {code:java}
> public static void copyToFile(final InputStream source, final File
> destination) throws IOException {
> try (OutputStream out = openOutputStream(destination)) {
> IOUtils.copy(source, out);
> }
> }{code}
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
