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