View Javadoc
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.test;
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 ThrowOnFlushAndCloseOutputStream extends ProxyOutputStream {
30  
31      private boolean throwOnFlush;
32      private boolean throwOnClose;
33  
34      /**
35       * @param proxy OutputStream to delegate to.
36       * @param throwOnFlush True if flush() is forbidden
37       * @param throwOnClose True if close() is forbidden
38       */
39      public ThrowOnFlushAndCloseOutputStream(final OutputStream proxy, final boolean throwOnFlush,
40          final boolean throwOnClose) {
41          super(proxy);
42          this.throwOnFlush = throwOnFlush;
43          this.throwOnClose = throwOnClose;
44      }
45  
46      /** @see java.io.OutputStream#close() */
47      @Override
48      public void close() throws IOException {
49          if (throwOnClose) {
50              fail(getClass().getSimpleName() + ".close() called.");
51          }
52          super.close();
53      }
54  
55      /** @see java.io.OutputStream#flush() */
56      @Override
57      public void flush() throws IOException {
58          if (throwOnFlush) {
59              fail(getClass().getSimpleName() + ".flush() called.");
60          }
61          super.flush();
62      }
63  
64      public void off() {
65          throwOnFlush = false;
66          throwOnClose = false;
67      }
68  
69  }