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 java.io.IOException;
20  import java.io.OutputStream;
21  
22  import junit.framework.AssertionFailedError;
23  
24  import org.apache.commons.io.output.ProxyOutputStream;
25  
26  /**
27   * Helper class for checking behaviour of IO classes.
28   * 
29   * @author <a href="mailto:jeremias@apache.org">Jeremias Maerki</a>
30   */
31  public class YellOnFlushAndCloseOutputStream extends ProxyOutputStream {
32  
33      private boolean yellForFlush;
34      private boolean yellForClose;
35  
36      /**
37       * @param proxy OutputStream to delegate to.
38       * @param yellForFlush True if flush() is forbidden
39       * @param yellForClose True if close() is forbidden
40       */
41      public YellOnFlushAndCloseOutputStream(OutputStream proxy, boolean yellForFlush, boolean yellForClose) {
42          super(proxy);
43          this.yellForFlush = yellForFlush;
44          this.yellForClose = yellForClose;
45      }
46  
47      /** @see java.io.OutputStream#flush() */
48      public void flush() throws IOException {
49          if (yellForFlush) {
50              throw new AssertionFailedError("flush() was called on OutputStream");
51          }
52          super.flush();
53      }
54  
55      /** @see java.io.OutputStream#close() */
56      public void close() throws IOException {
57          if (yellForClose) {
58              throw new AssertionFailedError("close() was called on OutputStream");
59          }
60          super.close();
61      }
62  
63      public void off() {
64          yellForFlush = false;
65          yellForClose = false;
66      }
67  
68  }