Coverage Report - org.apache.commons.io.input.TeeInputStream
 
Classes in this File Line Coverage Branch Coverage Complexity
TeeInputStream
81%
18/22
75%
6/8
1.667
 
 1  
 /*
 2  
  * Licensed to the Apache Software Foundation (ASF) under one or more
 3  
  * contributor license agreements.  See the NOTICE file distributed with
 4  
  * this work for additional information regarding copyright ownership.
 5  
  * The ASF licenses this file to You under the Apache License, Version 2.0
 6  
  * (the "License"); you may not use this file except in compliance with
 7  
  * the License.  You may obtain a copy of the License at
 8  
  * 
 9  
  *      http://www.apache.org/licenses/LICENSE-2.0
 10  
  * 
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.apache.commons.io.input;
 18  
 
 19  
 import static org.apache.commons.io.IOUtils.EOF;
 20  
 
 21  
 import java.io.IOException;
 22  
 import java.io.InputStream;
 23  
 import java.io.OutputStream;
 24  
 
 25  
 /**
 26  
  * InputStream proxy that transparently writes a copy of all bytes read
 27  
  * from the proxied stream to a given OutputStream. Using {@link #skip(long)}
 28  
  * or {@link #mark(int)}/{@link #reset()} on the stream will result on some
 29  
  * bytes from the input stream being skipped or duplicated in the output
 30  
  * stream.
 31  
  * <p>
 32  
  * The proxied input stream is closed when the {@link #close()} method is
 33  
  * called on this proxy. It is configurable whether the associated output
 34  
  * stream will also closed.
 35  
  *
 36  
  * @version $Id: TeeInputStream.java 1586350 2014-04-10 15:57:20Z ggregory $
 37  
  * @since 1.4
 38  
  */
 39  
 public class TeeInputStream extends ProxyInputStream {
 40  
 
 41  
     /**
 42  
      * The output stream that will receive a copy of all bytes read from the
 43  
      * proxied input stream.
 44  
      */
 45  
     private final OutputStream branch;
 46  
 
 47  
     /**
 48  
      * Flag for closing also the associated output stream when this
 49  
      * stream is closed.
 50  
      */
 51  
     private final boolean closeBranch;
 52  
 
 53  
     /**
 54  
      * Creates a TeeInputStream that proxies the given {@link InputStream}
 55  
      * and copies all read bytes to the given {@link OutputStream}. The given
 56  
      * output stream will not be closed when this stream gets closed.
 57  
      *
 58  
      * @param input input stream to be proxied
 59  
      * @param branch output stream that will receive a copy of all bytes read
 60  
      */
 61  
     public TeeInputStream(final InputStream input, final OutputStream branch) {
 62  7
         this(input, branch, false);
 63  7
     }
 64  
 
 65  
     /**
 66  
      * Creates a TeeInputStream that proxies the given {@link InputStream}
 67  
      * and copies all read bytes to the given {@link OutputStream}. The given
 68  
      * output stream will be closed when this stream gets closed if the
 69  
      * closeBranch parameter is {@code true}.
 70  
      *
 71  
      * @param input input stream to be proxied
 72  
      * @param branch output stream that will receive a copy of all bytes read
 73  
      * @param closeBranch flag for closing also the output stream when this
 74  
      *                    stream is closed
 75  
      */
 76  
     public TeeInputStream(
 77  
             final InputStream input, final OutputStream branch, final boolean closeBranch) {
 78  7
         super(input);
 79  7
         this.branch = branch;
 80  7
         this.closeBranch = closeBranch;
 81  7
     }
 82  
 
 83  
     /**
 84  
      * Closes the proxied input stream and, if so configured, the associated
 85  
      * output stream. An exception thrown from one stream will not prevent
 86  
      * closing of the other stream.
 87  
      *
 88  
      * @throws IOException if either of the streams could not be closed
 89  
      */
 90  
     @Override
 91  
     public void close() throws IOException {
 92  
         try {
 93  0
             super.close();
 94  
         } finally {
 95  0
             if (closeBranch) {
 96  0
                 branch.close();
 97  
             }
 98  
         }
 99  0
     }
 100  
 
 101  
     /**
 102  
      * Reads a single byte from the proxied input stream and writes it to
 103  
      * the associated output stream.
 104  
      *
 105  
      * @return next byte from the stream, or -1 if the stream has ended
 106  
      * @throws IOException if the stream could not be read (or written) 
 107  
      */
 108  
     @Override
 109  
     public int read() throws IOException {
 110  13
         final int ch = super.read();
 111  13
         if (ch != EOF) {
 112  10
             branch.write(ch);
 113  
         }
 114  13
         return ch;
 115  
     }
 116  
 
 117  
     /**
 118  
      * Reads bytes from the proxied input stream and writes the read bytes
 119  
      * to the associated output stream.
 120  
      *
 121  
      * @param bts byte buffer
 122  
      * @param st start offset within the buffer
 123  
      * @param end maximum number of bytes to read
 124  
      * @return number of bytes read, or -1 if the stream has ended
 125  
      * @throws IOException if the stream could not be read (or written) 
 126  
      */
 127  
     @Override
 128  
     public int read(final byte[] bts, final int st, final int end) throws IOException {
 129  2
         final int n = super.read(bts, st, end);
 130  2
         if (n != -1) {
 131  1
             branch.write(bts, st, n);
 132  
         }
 133  2
         return n;
 134  
     }
 135  
 
 136  
     /**
 137  
      * Reads bytes from the proxied input stream and writes the read bytes
 138  
      * to the associated output stream.
 139  
      *
 140  
      * @param bts byte buffer
 141  
      * @return number of bytes read, or -1 if the stream has ended
 142  
      * @throws IOException if the stream could not be read (or written) 
 143  
      */
 144  
     @Override
 145  
     public int read(final byte[] bts) throws IOException {
 146  2
         final int n = super.read(bts);
 147  2
         if (n != EOF) {
 148  1
             branch.write(bts, 0, n);
 149  
         }
 150  2
         return n;
 151  
     }
 152  
 
 153  
 }