/*
 * 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.jena.iri;

/**
 * A violation detected in an IRI has resulted
 * was classified as an error. This classification
 * depends on the settings of the {@link IRIFactory}.
 * 
 * Some methods, such as {@link IRIFactoryI#create(String)},
 * do not throw exceptions when they encounter such as errors,
 * but merely remember the error to be accessed by the user
 * using {@link IRI#violations(boolean)}.
 */
abstract public class IRIException extends RuntimeException  {


    protected IRIException() {
        super();
        
    }
    
    /**
     * Access details of the error in the IRI being processed. 
     * @return The error that caused this exception
     */
    abstract public Violation getViolation();
    
   

}
