View Javadoc
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  package org.apache.commons.io.output;
18  
19  import java.io.IOException;
20  import java.io.OutputStream;
21  
22  /**
23   * Writes all data to the famous <b>/dev/null</b>.
24   * <p>
25   * This output stream has no destination (file/socket etc.) and all bytes written to it are ignored and lost.
26   * </p>
27   */
28  public class NullOutputStream extends OutputStream {
29  
30      /**
31       * Deprecated in favor of {@link #NULL_OUTPUT_STREAM}.
32       *
33       * TODO: Will be private in 3.0.
34       *
35       * @deprecated Use {@link #NULL_OUTPUT_STREAM}.
36       */
37      @Deprecated
38      public NullOutputStream() {
39      }
40  
41      /**
42       * The singleton.
43       */
44      public static final NullOutputStreamtml#NullOutputStream">NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
45  
46      /**
47       * Does nothing - output to {@code /dev/null}.
48       *
49       * @param b The bytes to write
50       * @param off The start offset
51       * @param len The number of bytes to write
52       */
53      @Override
54      public void write(final byte[] b, final int off, final int len) {
55          // To /dev/null
56      }
57  
58      /**
59       * Does nothing - output to {@code /dev/null}.
60       *
61       * @param b The byte to write
62       */
63      @Override
64      public void write(final int b) {
65          // To /dev/null
66      }
67  
68      /**
69       * Does nothing - output to {@code /dev/null}.
70       *
71       * @param b The bytes to write
72       * @throws IOException never
73       */
74      @Override
75      public void write(final byte[] b) throws IOException {
76          // To /dev/null
77      }
78  
79  }