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