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 and all bytes written to it are ignored.
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 * <p>
48 * TODO: Will be private in 3.0.
49 * </p>
50 *
51 * @deprecated Use {@link #INSTANCE}.
52 */
53 @Deprecated
54 public NullOutputStream() {
55 // empty
56 }
57
58 /**
59 * Does nothing.
60 *
61 * @param b The This method ignores this parameter.
62 * @throws IOException This method never throws any exceptions.
63 */
64 @Override
65 public void write(final byte[] b) throws IOException {
66 // noop
67 }
68
69 /**
70 * Does nothing.
71 *
72 * @param b This method ignores this parameter.
73 * @param off This method ignores this parameter.
74 * @param len This method ignores this parameter.
75 */
76 @Override
77 public void write(final byte[] b, final int off, final int len) {
78 // noop
79 }
80
81 /**
82 * Does nothing.
83 *
84 * @param b This method ignores this parameter.
85 */
86 @Override
87 public void write(final int b) {
88 // noop
89 }
90
91 }