net.dv8tion.jda.api.events.ExceptionEvent Maven / Gradle / Ivy
Show all versions of JDA Show documentation
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.events;
import net.dv8tion.jda.api.JDA;
import javax.annotation.Nonnull;
/**
* Indicates that JDA encountered a Throwable that could not be forwarded to another end-user frontend.
*
For instance this is fired for events in internal WebSocket handling or audio threads.
* This includes {@link java.lang.Error Errors} and {@link com.neovisionaries.ws.client.WebSocketException WebSocketExceptions}
*
* It is not recommended to simply use this and print each event as some throwables were already logged
* by JDA. See {@link #isLogged()}.
*/
public class ExceptionEvent extends Event
{
protected final Throwable throwable;
protected final boolean logged;
public ExceptionEvent(@Nonnull JDA api, @Nonnull Throwable throwable, boolean logged)
{
super(api);
this.throwable = throwable;
this.logged = logged;
}
/**
* Whether this Throwable was already printed using the JDA logging system
*
* @return True, if this throwable was already logged
*/
public boolean isLogged()
{
return logged;
}
/**
* The cause Throwable for this event
*
* @return The cause
*/
@Nonnull
public Throwable getCause()
{
return throwable;
}
}