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 * Never writes data. Calls never go beyond this class.
024 * <p>
025 * This output stream has no destination and all bytes written to it are ignored.
026 * </p>
027 */
028public class NullOutputStream extends OutputStream {
029
030    /**
031     * The singleton instance.
032     *
033     * @since 2.12.0
034     */
035    public static final NullOutputStream INSTANCE = new NullOutputStream();
036
037    /**
038     * The singleton instance.
039     *
040     * @deprecated Use {@link #INSTANCE}.
041     */
042    @Deprecated
043    public static final NullOutputStream NULL_OUTPUT_STREAM = INSTANCE;
044
045    /**
046     * Deprecated in favor of {@link #INSTANCE}.
047     * <p>
048     * TODO: Will be private in 3.0.
049     * </p>
050     *
051     * @deprecated Use {@link #INSTANCE}.
052     */
053    @Deprecated
054    public NullOutputStream() {
055        // empty
056    }
057
058    /**
059     * Does nothing.
060     *
061     * @param b The This method ignores this parameter.
062     * @throws IOException This method never throws any exceptions.
063     */
064    @Override
065    public void write(final byte[] b) throws IOException {
066        // noop
067    }
068
069    /**
070     * Does nothing.
071     *
072     * @param b This method ignores this parameter.
073     * @param off This method ignores this parameter.
074     * @param len This method ignores this parameter.
075     */
076    @Override
077    public void write(final byte[] b, final int off, final int len) {
078        // noop
079    }
080
081    /**
082     * Does nothing.
083     *
084     * @param b This method ignores this parameter.
085     */
086    @Override
087    public void write(final int b) {
088        // noop
089    }
090
091}