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 * https://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
18 package org.apache.commons.io.output;
19
20 import java.io.IOException;
21
22 /**
23 * Appends all data to the famous <strong>/dev/null</strong>.
24 * <p>
25 * This Appendable has no destination (file/socket etc.) and all characters written to it are ignored and lost.
26 * </p>
27 *
28 * @since 2.8.0
29 */
30 public class NullAppendable implements Appendable { // NOPMD Class will be final in 3.0.
31
32 /**
33 * A singleton.
34 */
35 public static final NullAppendable INSTANCE = new NullAppendable();
36
37 /** Use the singleton. */
38 private NullAppendable() {
39 // no instances.
40 }
41
42 @Override
43 public Appendable append(final char c) throws IOException {
44 return this;
45 }
46
47 @Override
48 public Appendable append(final CharSequence csq) throws IOException {
49 return this;
50 }
51
52 @Override
53 public Appendable append(final CharSequence csq, final int start, final int end) throws IOException {
54 return this;
55 }
56
57 }