/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.sis.referencing.gazetteer;


/**
 * Thrown when a geographic identifier (or reference) has been successfully parsed but fails some verification.
 * Examples:
 *
 * <ul>
 *   <li>The <i>100 000-metres square identification</i> of a {@linkplain MilitaryGridReferenceSystem MGRS}
 *       reference is not consistent with the <i>Grid Zone Designation</i>.</li>
 * </ul>
 *
 * The purpose of those verifications is to perform some error detection.
 * For example, it may help to detect if a typo occurred when a user entered a coordinate manually.
 *
 * @author  Martin Desruisseaux (Geomatys)
 * @version 0.8
 * @since   0.8
 */
public class ReferenceVerifyException extends GazetteerException {
    /**
     * Serial number for inter-operability with different versions.
     */
    private static final long serialVersionUID = 7501102047565324537L;

    /**
     * Constructs a new exception with no detail message.
     */
    public ReferenceVerifyException() {
    }

    /**
     * Constructs a new exception with the specified detail message.
     *
     * @param  message  the details message, or {@code null} if none.
     */
    public ReferenceVerifyException(final String message) {
        super(message);
    }

    /**
     * Constructs a new exception with the specified cause.
     * The details message is copied from the cause.
     *
     * @param  cause  the cause, or {@code null} if none.
     */
    public ReferenceVerifyException(final Throwable cause) {
        super(cause);
    }

    /**
     * Constructs a new exception with the specified detail message and cause.
     *
     * @param  message  the details message, or {@code null} if none.
     * @param  cause    the cause, or {@code null} if none.
     */
    public ReferenceVerifyException(final String message, final Throwable cause) {
        super(message, cause);
    }
}
