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.output;
18  
19  import java.io.IOException;
20  import java.io.Writer;
21  
22  /**
23   * Broken writer. This writer always throws an {@link IOException} from
24   * all {@link Writer} methods.
25   * <p>
26   * This class is mostly useful for testing error handling in code that uses a
27   * writer.
28   * </p>
29   *
30   * @since 2.0
31   */
32  public class BrokenWriter extends Writer {
33  
34      /**
35       * The exception that is thrown by all methods of this class.
36       */
37      private final IOException exception;
38  
39      /**
40       * Creates a new writer that always throws the given exception.
41       *
42       * @param exception the exception to be thrown
43       */
44      public BrokenWriter(final IOException exception) {
45          this.exception = exception;
46      }
47  
48      /**
49       * Creates a new writer that always throws an {@link IOException}
50       */
51      public BrokenWriter() {
52          this(new IOException("Broken writer"));
53      }
54  
55      /**
56       * Throws the configured exception.
57       *
58       * @param cbuf ignored
59       * @param off ignored
60       * @param len ignored
61       * @throws IOException always thrown
62       */
63      @Override
64      public void write(final char[] cbuf, final int off, final int len) throws IOException {
65          throw exception;
66      }
67  
68      /**
69       * Throws the configured exception.
70       *
71       * @throws IOException always thrown
72       */
73      @Override
74      public void flush() throws IOException {
75          throw exception;
76      }
77  
78      /**
79       * Throws the configured exception.
80       *
81       * @throws IOException always thrown
82       */
83      @Override
84      public void close() throws IOException {
85          throw exception;
86      }
87  
88  }