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