001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one or more
003     * contributor license agreements.  See the NOTICE file distributed with
004     * this work for additional information regarding copyright ownership.
005     * The ASF licenses this file to You under the Apache License, Version 2.0
006     * (the "License"); you may not use this file except in compliance with
007     * the License.  You may obtain a copy of the License at
008     * 
009     *      http://www.apache.org/licenses/LICENSE-2.0
010     * 
011     * Unless required by applicable law or agreed to in writing, software
012     * distributed under the License is distributed on an "AS IS" BASIS,
013     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     * See the License for the specific language governing permissions and
015     * limitations under the License.
016     */
017    package org.apache.commons.io.output;
018     
019    import java.io.IOException;
020    import java.io.OutputStream;
021    
022    /**
023     * This OutputStream writes all data to the famous <b>/dev/null</b>.
024     * <p>
025     * This output stream has no destination (file/socket etc.) and all
026     * bytes written to it are ignored and lost.
027     * 
028     * @author Jeremias Maerki
029     * @version $Id: NullOutputStream.java 659817 2008-05-24 13:23:10Z niallp $
030     */
031    public class NullOutputStream extends OutputStream {
032        
033        /**
034         * A singleton.
035         */
036        public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
037    
038        /**
039         * Does nothing - output to <code>/dev/null</code>.
040         * @param b The bytes to write
041         * @param off The start offset
042         * @param len The number of bytes to write
043         */
044        @Override
045        public void write(byte[] b, int off, int len) {
046            //to /dev/null
047        }
048    
049        /**
050         * Does nothing - output to <code>/dev/null</code>.
051         * @param b The byte to write
052         */
053        @Override
054        public void write(int b) {
055            //to /dev/null
056        }
057    
058        /**
059         * Does nothing - output to <code>/dev/null</code>.
060         * @param b The bytes to write
061         * @throws IOException never
062         */
063        @Override
064        public void write(byte[] b) throws IOException {
065            //to /dev/null
066        }
067    
068    }