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 * Never writes data. Calls never go beyond this class. 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 * The singleton instance. 32 * 33 * @since 2.12.0 34 */ 35 public static final NullOutputStream INSTANCE = new NullOutputStream(); 36 37 /** 38 * The singleton instance. 39 * 40 * @deprecated Use {@link #INSTANCE}. 41 */ 42 @Deprecated 43 public static final NullOutputStream NULL_OUTPUT_STREAM = INSTANCE; 44 45 /** 46 * Deprecated in favor of {@link #INSTANCE}. 47 * 48 * TODO: Will be private in 3.0. 49 * 50 * @deprecated Use {@link #INSTANCE}. 51 */ 52 @Deprecated NullOutputStream()53 public NullOutputStream() { 54 } 55 56 /** 57 * Does nothing - output to {@code /dev/null}. 58 * 59 * @param b The bytes to write 60 * @throws IOException never 61 */ 62 @Override write(final byte[] b)63 public void write(final byte[] b) throws IOException { 64 // To /dev/null 65 } 66 67 /** 68 * Does nothing - output to {@code /dev/null}. 69 * 70 * @param b The bytes to write 71 * @param off The start offset 72 * @param len The number of bytes to write 73 */ 74 @Override write(final byte[] b, final int off, final int len)75 public void write(final byte[] b, final int off, final int len) { 76 // To /dev/null 77 } 78 79 /** 80 * Does nothing - output to {@code /dev/null}. 81 * 82 * @param b The byte to write 83 */ 84 @Override write(final int b)85 public void write(final int b) { 86 // To /dev/null 87 } 88 89 } 90