TransformerSourceErrorEvent.java

/*
 * This file is part of the GeoLatte project.
 *
 *     GeoLatte 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.
 *
 *     GeoLatte 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 Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with GeoLatte.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Copyright (C) 2010 - 2010 and Ownership of code is shared by:
 * Qmino bvba - Romeinsestraat 18 - 3001 Heverlee  (http://www.qmino.com)
 * Geovise bvba - Generaal Eisenhowerlei 9 - 2140 Antwerpen (http://www.geovise.com)
 */

package org.geolatte.common.transformer;

/**
 * <p>
 * Event fired when a TransformerSource encounters an error. This may be a one-time error, when further values may still be provided, or a more serious error, when the TransformerSource terminates and will stop providing further values.
 * </p>
 * <p>
 * <i>Creation-Date</i>: 04-May-2010<br>
 * <i>Creation-Time</i>:  10:44:45<br>
 * </p>
 *
 * @author Bert Vanhooff
 * @author <a href="http://www.qmino.com">Qmino bvba</a>
 * @since SDK1.5
 */
public class TransformerSourceErrorEvent extends ErrorEvent {

    private boolean isTerminating;

    /**
     * Constructs a prototypical Event.
     *
     * @param source The object on which the Event initially occurred.
     * @throws IllegalArgumentException if source is null.
     */
    public TransformerSourceErrorEvent(Object source) {
        super(source);
    }

    /**
     * Constructs an event with the exception that caused the error.
     *
     * @param source    The object on which the Event initially occurred.
     * @param exception The exception that caused the error.
     * @throws IllegalArgumentException if source is null.
     */
    public TransformerSourceErrorEvent(Object source, Exception exception) {
        super(source, exception);
    }

    /**
     * Constructs an event with the exception that caused the error and a value indicating whether the TransformerSource will stop producing further values or not.
     *
     * @param source    The object on which the Event initially occurred.
     * @param exception The exception that caused the error.
     * @param terminating True if the TransformerSource will not produce further values, false if the TransformerSource may still be able to provide further values. 
     * @throws IllegalArgumentException if source is null.
     */
    public TransformerSourceErrorEvent(Object source, Exception exception, boolean terminating) {
        super(source, exception);
        isTerminating = terminating;
    }

    /**
     * Gets a value indicating whether the source will stop producing new values as consequence of the error.
     * If true, no further values will be produced. If false, the error occurred for the current provided value only; future values may still be provided.
     * @return A value indicating whether the source can produce further values.
     */
    public boolean getIsTerminating() {
        return isTerminating;
    }
}