001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.geometry.core.internal;
018
019/** Exception thrown when something that should not happen does happen.
020 * This class is not intended to be part of the public API and should
021 * never be seen by the user when algorithms are functioning correctly.
022 */
023public class GeometryInternalError extends IllegalStateException {
024
025    /** Error message used for exceptions of this type. */
026    private static final String ERROR_MSG = "An internal geometry error occurred. This most often indicates an " +
027            "error in the algorithm implementation than in the calling code or data. Please file a bug report " +
028            "with the developers.";
029
030    /** Serializable version identifier. */
031    private static final long serialVersionUID = 20180913L;
032
033    /** Simple constructor with a default error message.
034     */
035    public GeometryInternalError() {
036        super(ERROR_MSG);
037    }
038}