ErrorEvent.java

/*
 * Copyright (c) 2007, 2011, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.opensolaris.os.dtrace;

import java.util.EventObject;

/**
 * Notification that DTrace has encountered an error.
 *
 * @see ConsumerListener#errorEncountered(ErrorEvent e)
 *
 * @author Tom Erickson
 */
public class ErrorEvent extends EventObject {
    static final long serialVersionUID = 2236600660422267215L;

    /**
     * Creates an {@link ConsumerListener#errorEncountered(ErrorEvent e)
     * errorEncountered()} event that reports an error encountered in
     * the native DTrace library during tracing.
     *
     * @param source the {@link Consumer} that is the source of this event
     * @param dtraceError the error encountered by DTrace
     * @throws NullPointerException if the given error is {@code null}
     */
    public
    ErrorEvent(Object source, Error dtraceError)
    {
	super(source);
    }

    /**
     * Gets the error reported by DTrace.
     *
     * @return non-null error reported by DTrace
     */
    public Error
    getError()
    {
	return null;
    }
}