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.testtools;
18
19 import static org.junit.jupiter.api.Assertions.fail;
20
21 import java.io.IOException;
22 import java.io.OutputStream;
23
24 import org.apache.commons.io.output.ProxyOutputStream;
25
26 /**
27 * Helper class for checking behavior of IO classes.
28 */
29 public class YellOnFlushAndCloseOutputStream extends ProxyOutputStream {
30
31 private boolean yellOnFlush;
32 private boolean yellOnClose;
33
34 /**
35 * @param proxy OutputStream to delegate to.
36 * @param yellOnFlush True if flush() is forbidden
37 * @param yellOnClose True if close() is forbidden
38 */
39 public YellOnFlushAndCloseOutputStream(final OutputStream proxy, final boolean yellOnFlush, final boolean yellOnClose) {
40 super(proxy);
41 this.yellOnFlush = yellOnFlush;
42 this.yellOnClose = yellOnClose;
43 }
44
45 /** @see java.io.OutputStream#flush() */
46 @Override
47 public void flush() throws IOException {
48 if (yellOnFlush) {
49 fail(getClass().getSimpleName() + ".flush() called.");
50 }
51 super.flush();
52 }
53
54 /** @see java.io.OutputStream#close() */
55 @Override
56 public void close() throws IOException {
57 if (yellOnClose) {
58 fail(getClass().getSimpleName() + ".close() called.");
59 }
60 super.close();
61 }
62
63 public void off() {
64 yellOnFlush = false;
65 yellOnClose = false;
66 }
67
68 }