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.geometry.core.internal;
18  
19  /** Exception thrown when something that should not happen does happen.
20   * This class is not intended to be part of the public API and should
21   * never be seen by the user when algorithms are functioning correctly.
22   */
23  public class GeometryInternalError extends IllegalStateException {
24  
25      /** Error message used for exceptions of this type. */
26      private static final String ERROR_MSG = "An internal geometry error occurred. This most often indicates an " +
27              "error in the algorithm implementation than in the calling code or data. Please file a bug report " +
28              "with the developers.";
29  
30      /** Serializable version identifier. */
31      private static final long serialVersionUID = 20180913L;
32  
33      /** Simple constructor with a default error message.
34       */
35      public GeometryInternalError() {
36          super(ERROR_MSG);
37      }
38  }