org.nerd4j.csv.exception.CSVProcessException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of nerd4j-csv Show documentation

CSV manipulation library.

There is a newer version: 1.2.0

/*
 * #%L
 * Nerd4j CSV
 * %%
 * Copyright (C) 2013 Nerd4j
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as 
 * published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public 
 * License along with this program.  If not, see
 * .
 * #L%
 */
package org.nerd4j.csv.exception;

import org.nerd4j.csv.CSVProcessError;

/**
 * Represents an error occurred during the manipulation of a CSV field.
 * 
 * @author Nerd4j Team
 */
public class CSVProcessException extends CSVException
{
	
	/** Serial Version UID. */
	private static final long serialVersionUID = 1L;
	
	/** The error occurred during process. */
	private CSVProcessError error;

	
	/**
	 * Constructs a new exception with the specified process error.
	 * 
	 * @param error the error that caused the exception.
	 */
	public CSVProcessException( CSVProcessError error )
	{
		
		super();
		
		this.error = error;
		
	}
	
	
	/* ******************* */
	/*  GETTERS & SETTERS  */
	/* ******************* */

	
	/**
	 * Returns the process error that caused the exception.
	 * 
	 * @return the process error.
	 */
	public CSVProcessError getError()
	{
	    
	    return error;
	    
	}

	
	/**
	 * {@inheritDoc}
	 */
	@Override
	public String getMessage()
	{
	    
	    return error != null ? error.getMessage() : null;
	    
	}
	
}