/*
 * Copyright 2016 Andrew Rucker Jones.
 *
 * Licensed 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 com.opencsv.exceptions;

This exception is thrown when logical connections between data fields would
be violated by the imported data.
This can be for constraints like making certain a number is in a certain
range, or it can even be thrown by code using opencsv when constraints
outside of opencsv would be violated. An example of the latter is importing
into a database when one of the field in the CSV is supposed to contain the
primary key for a foreign table, but the foreign key cannot be satisfied.
This exception is not currently used by opencsv itself, since opencsv has
no concept of what data consistency means in the context of the application
using it. It is meant more for custom converters.
Author:
Andrew Rucker Jones
Since:
3.8/**
 * This exception is thrown when logical connections between data fields would
 * be violated by the imported data.
 * <p>This can be for constraints like making certain a number is in a certain
 * range, or it can even be thrown by code using opencsv when constraints
 * outside of opencsv would be violated. An example of the latter is importing
 * into a database when one of the field in the CSV is supposed to contain the
 * primary key for a foreign table, but the foreign key cannot be satisfied.</p>
 * <p>This exception is not currently used by opencsv itself, since opencsv has
 * no concept of what data consistency means in the context of the application
 * using it. It is meant more for custom converters.</p>
 *
 * @author Andrew Rucker Jones
 * @since 3.8
 */
public class CsvConstraintViolationException extends CsvException {
    private static final long serialVersionUID = 1L;

    private transient final Object sourceObject;

    
Default constructor, in case no further information is necessary or
available.
/**
     * Default constructor, in case no further information is necessary or
     * available.
     */
    public CsvConstraintViolationException() {
        sourceObject = null;
    }

    
Constructor for setting the source object that triggered the constraint
violation.
Params:
sourceObject – The offending source object/**
     * Constructor for setting the source object that triggered the constraint
     * violation.
     *
     * @param sourceObject The offending source object
     */
    public CsvConstraintViolationException(Object sourceObject) {
        this.sourceObject = sourceObject;
    }

    
Constructor with a simple text.
Params:
message – Human-readable error text/**
     * Constructor with a simple text.
     *
     * @param message Human-readable error text
     */
    public CsvConstraintViolationException(String message) {
        super(message);
        sourceObject = null;
    }

    
Constructor for setting the source object and an error message.
Params:
sourceObject – The offending source object
message –      Human-readable error text/**
     * Constructor for setting the source object and an error message.
     *
     * @param sourceObject The offending source object
     * @param message      Human-readable error text
     */
    public CsvConstraintViolationException(Object sourceObject, String message) {
        super(message);
        this.sourceObject = sourceObject;
    }

    
Gets the object that would have caused a constraint violation. sourceObject is marked transient, because Object is not Serializable. If for any reason this exception is serialized and deserialized, this method will subsequently return null. 
Returns:
The source object that triggered the constraint violation/**
     * Gets the object that would have caused a constraint violation.
     * {@code sourceObject} is marked {@code transient}, because
     * {@link java.lang.Object} is not {@link java.io.Serializable}. If
     * for any reason this exception is serialized and deserialized, this method
     * will subsequently return {@code null}.
     * 
     * @return The source object that triggered the constraint violation
     */
    public Object getSourceObject() {
        return sourceObject;
    }
}