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   * @version $Id$
29   */
30  public class NullOutputStream extends OutputStream {
31  
32      /**
33       * A singleton.
34       */
35      public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
36  
37      /**
38       * Does nothing - output to <code>/dev/null</code>.
39       * @param b The bytes to write
40       * @param off The start offset
41       * @param len The number of bytes to write
42       */
43      @Override
44      public void write(final byte[] b, final int off, final int len) {
45          //to /dev/null
46      }
47  
48      /**
49       * Does nothing - output to <code>/dev/null</code>.
50       * @param b The byte to write
51       */
52      @Override
53      public void write(final int b) {
54          //to /dev/null
55      }
56  
57      /**
58       * Does nothing - output to <code>/dev/null</code>.
59       * @param b The bytes to write
60       * @throws IOException never
61       */
62      @Override
63      public void write(final byte[] b) throws IOException {
64          //to /dev/null
65      }
66  
67  }