org.geolatte.common.transformer.ErrorEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of geolatte-common Show documentation

This GeoLatte-common library contains the transformer framework and other common classes used by other GeoLatte modules.

There is a newer version: 0.8

Show newest version

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

import java.util.EventObject;

/**
 * 
 * A base event object that can be fired when an exception is caught or a general error occurred.
 * 
 * 
 * Creation-Date: 04-May-2010

 * Creation-Time:  10:45:36

 * 
 *
 * @author Bert Vanhooff
 * @author Qmino bvba
 * @since SDK1.5
 */
public class ErrorEvent extends EventObject {

    private Exception exception;

    /**
     * Constructs a prototypical Event.
     *
     * @param source The object on which the Event initially occurred.
     * @throws IllegalArgumentException if source is null.
     */
    public ErrorEvent(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 ErrorEvent(Object source, Exception exception) {
        super(source);
        this.exception = exception;
    }

    /**
     * Gets the exception that caused the error. Can be null.
     * @return The exception that was thrown during execution.
     */
    public Exception getException() {

        return exception;
    }
}