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 */
029public class NullOutputStream extends OutputStream {
030
031    /**
032     * Deprecated in favor of {@link #NULL_OUTPUT_STREAM}.
033     *
034     * TODO: Will be private in 3.0.
035     *
036     * @deprecated Use {@link #NULL_OUTPUT_STREAM}.
037     */
038    @Deprecated
039    public NullOutputStream() {
040        super();
041    }
042
043    /**
044     * A singleton.
045     */
046    public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
047
048    /**
049     * Does nothing - output to <code>/dev/null</code>.
050     *
051     * @param b The bytes to write
052     * @param off The start offset
053     * @param len The number of bytes to write
054     */
055    @Override
056    public void write(final byte[] b, final int off, final int len) {
057        // To /dev/null
058    }
059
060    /**
061     * Does nothing - output to <code>/dev/null</code>.
062     *
063     * @param b The byte to write
064     */
065    @Override
066    public void write(final int b) {
067        // To /dev/null
068    }
069
070    /**
071     * Does nothing - output to <code>/dev/null</code>.
072     *
073     * @param b The bytes to write
074     * @throws IOException never
075     */
076    @Override
077    public void write(final byte[] b) throws IOException {
078        // To /dev/null
079    }
080
081}