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.input;
18
19 import java.io.Reader;
20
21 /**
22 * Proxy reader that prevents the underlying reader from being closed.
23 * <p>
24 * This class is typically used in cases where a reader needs to be passed to a
25 * component that wants to explicitly close the reader even if more input would
26 * still be available to other components.
27 * </p>
28 *
29 * @since 2.7
30 */
31 public class CloseShieldReader extends ProxyReader {
32
33 /**
34 * Constructs a proxy that shields the given reader from being closed.
35 *
36 * @param reader the reader to wrap
37 * @return the created proxy
38 * @since 2.9.0
39 */
40 public static CloseShieldReader wrap(final Reader reader) {
41 return new CloseShieldReader(reader);
42 }
43
44 /**
45 * Constructs a proxy that shields the given reader from being closed.
46 *
47 * @param reader underlying reader
48 * @deprecated Using this constructor prevents IDEs from warning if the
49 * underlying reader is never closed. Use {@link #wrap(Reader)}
50 * instead.
51 */
52 @Deprecated
53 public CloseShieldReader(final Reader reader) {
54 super(reader);
55 }
56
57 /**
58 * Replaces the underlying reader with a {@link ClosedReader} sentinel. The
59 * original reader will remain open, but this proxy will appear closed.
60 */
61 @Override
62 public void close() {
63 in = ClosedReader.INSTANCE;
64 }
65
66 }