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 */
017
018package org.apache.commons.io.output;
019
020import java.io.PrintStream;
021
022/**
023 * Never prints data. Calls never go beyond this class.
024 * <p>
025 * This print stream has no destination (file/socket etc.) and all bytes written to it are ignored and lost.
026 * </p>
027 *
028 * @since 2.7
029 */
030public class NullPrintStream extends PrintStream {
031
032    /**
033     * The singleton instance.
034     *
035     * @since 2.12.0
036     */
037    public static final NullPrintStream INSTANCE = new NullPrintStream();
038
039    /**
040     * The singleton instance.
041     *
042     * @deprecated Use {@link #INSTANCE}.
043     */
044    @Deprecated
045    public static final NullPrintStream NULL_PRINT_STREAM = INSTANCE;
046
047    /**
048     * Constructs an instance.
049     *
050     * @deprecated Use {@link #INSTANCE}.
051     */
052    @Deprecated
053    public NullPrintStream() {
054        // Relies on the default charset which is OK since we are not actually writing.
055        super(NullOutputStream.INSTANCE);
056    }
057
058}