    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        super();
    040    }
    041
    042    /**
    043     * A singleton.
    044     */
    045    public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
    046
    047    /**
    048     * Does nothing - output to <code>/dev/null</code>.
    049     *
    050     * @param b The bytes to write
    051     * @param off The start offset
    052     * @param len The number of bytes to write
    053     */
    054    @Override
    055    public void write(final byte[] b, final int off, final int len) {
    056        // To /dev/null
    057    }
    058
    059    /**
    060     * Does nothing - output to <code>/dev/null</code>.
    061     *
    062     * @param b The byte to write
    063     */
    064    @Override
    065    public void write(final int b) {
    066        // To /dev/null
    067    }
    068
    069    /**
    070     * Does nothing - output to <code>/dev/null</code>.
    071     *
    072     * @param b The bytes to write
    073     * @throws IOException never
    074     */
    075    @Override
    076    public void write(final byte[] b) throws IOException {
    077        // To /dev/null
    078    }
    079
    080}