• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements.  See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License.  You may obtain a copy of the License at
8  *
9  *      http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 package org.apache.commons.io.output;
19 
20 import java.io.PrintStream;
21 
22 /**
23  * Never prints data. Calls never go beyond this class.
24  * <p>
25  * This print stream has no destination (file/socket etc.) and all bytes written to it are ignored and lost.
26  * </p>
27  *
28  * @since 2.7
29  */
30 public class NullPrintStream extends PrintStream {
31 
32     /**
33      * The singleton instance.
34      *
35      * @since 2.12.0
36      */
37     public static final NullPrintStream INSTANCE = new NullPrintStream();
38 
39     /**
40      * The singleton instance.
41      *
42      * @deprecated Use {@link #INSTANCE}.
43      */
44     @Deprecated
45     public static final NullPrintStream NULL_PRINT_STREAM = INSTANCE;
46 
47     /**
48      * Constructs an instance.
49      */
NullPrintStream()50     public NullPrintStream() {
51         // Relies on the default charset which is OK since we are not actually writing.
52         super(NullOutputStream.INSTANCE);
53     }
54 
55 }
56