javafx.scene.media.MediaErrorEvent Maven / Gradle / Ivy
/*
* Copyright (c) 2010, 2022, 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 javafx.scene.media;
import javafx.event.Event;
import javafx.event.EventTarget;
import javafx.event.EventType;
/**
* An {@link Event} representing the occurrence of an error in handling media.
* @since JavaFX 2.0
*/
public class MediaErrorEvent extends Event {
private static final long serialVersionUID = 20121107L;
/**
* The only valid event type for the MediaErrorEvent.
*/
public static final EventType MEDIA_ERROR =
new EventType<>(Event.ANY, "Media Error Event");
/**
* The {@link MediaException} which provoked this error event.
*/
private MediaException error;
/**
* Construct a new MediaErrorEvent with the specified event
* source, target and error.
*
* @param source the event source which sent the event
* @param target the event target to associate with the event
* @param error the error which provoked the event
* @throws IllegalArgumentException if error is
* null.
*/
MediaErrorEvent(Object source, EventTarget target, MediaException error) {
super(source, target, MEDIA_ERROR);
if(error == null) {
throw new IllegalArgumentException("error == null!");
}
this.error = error;
}
/**
* Retrieve the error associated with this event.
*
* @return The MediaException
*/
public MediaException getMediaError() {
return error;
}
/**
* Retrieve a String representation of the event.
*/
@Override
public String toString() {
return super.toString() + ": source " + getSource() +
"; target " + getTarget() + "; error " + error;
}
@Override
public MediaErrorEvent copyFor(Object newSource, EventTarget newTarget) {
return (MediaErrorEvent) super.copyFor(newSource, newTarget);
}
@Override
public EventType getEventType() {
return (EventType) super.getEventType();
}
}