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  
18  package org.apache.commons.io.input;
19  
20  /**
21   * Package-private factory for {@link UnsupportedOperationException} to provide messages with consistent formatting.
22   *
23   * <p>
24   * TODO Consider making this public and use from LineIterator but this feels like it belongs in LANG rather than IO.
25   * </p>
26   */
27  final class UnsupportedOperationExceptions {
28  
29      private static final String MARK_RESET = "mark/reset";
30  
31      /**
32       * Constructs a new instance of UnsupportedOperationException for a {@code mark} method.
33       *
34       * @return a new instance of UnsupportedOperationException
35       */
36      static UnsupportedOperationException mark() {
37          // Use the same message as in java.io.InputStream.reset() in OpenJDK 8.0.275-1.
38          return method(MARK_RESET);
39      }
40  
41      /**
42       * Constructs a new instance of UnsupportedOperationException for the given unsupported a {@code method} name.
43       *
44       * @param method A method name
45       * @return a new instance of UnsupportedOperationException
46       */
47      static UnsupportedOperationException method(final String method) {
48          return new UnsupportedOperationException(method + " not supported");
49      }
50  
51      /**
52       * Constructs a new instance of UnsupportedOperationException for a {@code reset} method.
53       *
54       * @return a new instance of UnsupportedOperationException
55       */
56      static UnsupportedOperationException reset() {
57          // Use the same message as in java.io.InputStream.reset() in OpenJDK 8.0.275-1.
58          return method(MARK_RESET);
59      }
60  }