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 */
017package org.apache.commons.io.output;
018
019import java.io.IOException;
020import 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 *</p>
028 * @version $Id: NullOutputStream.java 1674708 2015-04-20 00:02:45Z ggregory $
029 */
030public class NullOutputStream extends OutputStream {
031
032    /**
033     * A singleton.
034     */
035    public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
036
037    /**
038     * Does nothing - output to <code>/dev/null</code>.
039     * @param b The bytes to write
040     * @param off The start offset
041     * @param len The number of bytes to write
042     */
043    @Override
044    public void write(final byte[] b, final int off, final int len) {
045        //to /dev/null
046    }
047
048    /**
049     * Does nothing - output to <code>/dev/null</code>.
050     * @param b The byte to write
051     */
052    @Override
053    public void write(final int b) {
054        //to /dev/null
055    }
056
057    /**
058     * Does nothing - output to <code>/dev/null</code>.
059     * @param b The bytes to write
060     * @throws IOException never
061     */
062    @Override
063    public void write(final byte[] b) throws IOException {
064        //to /dev/null
065    }
066
067}