Open Source Repository

Home /commons-io/commons-io-2.1 | Repository Home


org/apache/commons/io/output/TeeOutputStream.java
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 
 *      http://www.apache.org/licenses/LICENSE-2.0
 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.io.output;

import java.io.IOException;
import java.io.OutputStream;

/**
 * Classic splitter of OutputStream. Named after the unix 'tee' 
 * command. It allows a stream to be branched off so there 
 * are now two streams.
 *
 @version $Id: TeeOutputStream.java 659817 2008-05-24 13:23:10Z niallp $
 */
public class TeeOutputStream extends ProxyOutputStream {

    /** the second OutputStream to write to */
    protected OutputStream branch;

    /**
     * Constructs a TeeOutputStream.
     @param out the main OutputStream
     @param branch the second OutputStream
     */
    public TeeOutputStreamOutputStream out, OutputStream branch ) {
        super(out);
        this.branch = branch;
    }

    /**
     * Write the bytes to both streams.
     @param b the bytes to write
     @throws IOException if an I/O error occurs
     */
    @Override
    public synchronized void write(byte[] bthrows IOException {
        super.write(b);
        this.branch.write(b);
    }

    /**
     * Write the specified bytes to both streams.
     @param b the bytes to write
     @param off The start offset
     @param len The number of bytes to write
     @throws IOException if an I/O error occurs
     */
    @Override
    public synchronized void write(byte[] b, int off, int lenthrows IOException {
        super.write(b, off, len);
        this.branch.write(b, off, len);
    }

    /**
     * Write a byte to both streams.
     @param b the byte to write
     @throws IOException if an I/O error occurs
     */
    @Override
    public synchronized void write(int bthrows IOException {
        super.write(b);
        this.branch.write(b);
    }

    /**
     * Flushes both streams.
     @throws IOException if an I/O error occurs
     */
    @Override
    public void flush() throws IOException {
        super.flush();
        this.branch.flush();
    }

    /**
     * Closes both streams. 
     @throws IOException if an I/O error occurs
     */
    @Override
    public void close() throws IOException {
        super.close();
        this.branch.close();
    }

}