Home | History | Annotate | Download | only in output
      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  *
     28  * @author Jeremias Maerki
     29  * @version $Id: NullOutputStream.java 610010 2008-01-08 14:50:59Z niallp $
     30  */
     31 public class NullOutputStream extends OutputStream {
     32 
     33     /**
     34      * A singleton.
     35      */
     36     public static final NullOutputStream NULL_OUTPUT_STREAM = new NullOutputStream();
     37 
     38     /**
     39      * Does nothing - output to <code>/dev/null</code>.
     40      * @param b The bytes to write
     41      * @param off The start offset
     42      * @param len The number of bytes to write
     43      */
     44     public void write(byte[] b, int off, 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     public void write(int b) {
     53         //to /dev/null
     54     }
     55 
     56     /**
     57      * Does nothing - output to <code>/dev/null</code>.
     58      * @param b The bytes to write
     59      * @throws IOException never
     60      */
     61     public void write(byte[] b) throws IOException {
     62         //to /dev/null
     63     }
     64 
     65 }
     66