package com.opencsv.exceptions;

import java.util.LinkedList;
import java.util.List;

An exception class for collecting multiple exceptions.
For internal use only.
Author:
Andrew Rucker Jones
Since:
5.3/**
 * An exception class for collecting multiple exceptions.
 * For internal use only.
 *
 * @author Andrew Rucker Jones
 * @since 5.3
 */
public class CsvChainedException extends CsvException {

    private final List<CsvFieldAssignmentException> exceptionChain = new LinkedList<>();

    
Constructor.
Params:
csve – The first exception for the list being collected. Must not be null./**
     * Constructor.
     * @param csve The first exception for the list being collected.
     *             Must not be {@code null}.
     */
    public CsvChainedException(CsvFieldAssignmentException csve) {
        exceptionChain.add(csve);
    }

    
Add an exception to the chain of collections.
Params:
csve – Exception to be added to this chain. Must not be null./**
     * Add an exception to the chain of collections.
     * @param csve Exception to be added to this chain.
     *             Must not be {@code null}.
     */
    public void add(CsvFieldAssignmentException csve) {
        exceptionChain.add(csve);
    }

    
Returns:
A list of all exceptions collected/**
     * @return A list of all exceptions collected
     */
    public List<CsvFieldAssignmentException> getExceptionChain() {
        return exceptionChain;
    }

    
Sets the line for all exceptions collected. /** Sets the line for all exceptions collected. */
    // The rest of the Javadoc is inherited
    @Override
    public void setLine(String[] line) {
        super.setLine(line);
        exceptionChain.forEach(e -> e.setLine(line));
    }

    
Sets the line number for all exceptions collected. /** Sets the line number for all exceptions collected. */
    // The rest of the Javadoc is inherited
    @Override
    public void setLineNumber(long lineNumber) {
        super.setLineNumber(lineNumber);
        exceptionChain.forEach(e -> e.setLineNumber(lineNumber));
    }

    
Convenience method that checks if the chain only has a single exception.
Returns:
true if chain has only a single exception, false otherwise/**
     * Convenience method that checks if the chain only has a single exception.
     *
     * @return {@code true} if chain has only a single exception,
     *   {@code false} otherwise
     */
    public boolean hasOnlyOneException() {
        return exceptionChain.size() == 1;
    }

    
Convenience method to return the first exception from the exception chain.
Returns:
CsvFieldAssignmentException at the first position in the list, null otherwise./**
     * Convenience method to return the first exception from the exception chain.
     *
     * @return {@link CsvFieldAssignmentException} at the first position in the
     * list, {@code null} otherwise.
     */
    public CsvFieldAssignmentException getFirstException() {
        return exceptionChain.isEmpty() ? null : exceptionChain.get(0);
    }
}