net.dv8tion.jda.api.events.Event 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;
/**
* Top-level event type
*
All events JDA fires are derived from this class.
*
* Can be used to check if an Object is a JDA event in {@link net.dv8tion.jda.api.hooks.EventListener EventListener} implementations to distinguish what event is being fired.
*
Adapter implementation: {@link net.dv8tion.jda.api.hooks.ListenerAdapter ListenerAdapter}
*/
public abstract class Event implements GenericEvent
{
protected final JDA api;
protected final long responseNumber;
/**
* Creates a new Event from the given JDA instance
*
* @param api
* Current JDA instance
* @param responseNumber
* The sequence number for this event
*
* @see #Event(net.dv8tion.jda.api.JDA)
*/
public Event(@Nonnull JDA api, long responseNumber)
{
this.api = api;
this.responseNumber = responseNumber;
}
/**
* Creates a new Event from the given JDA instance
*
Uses the current {@link net.dv8tion.jda.api.JDA#getResponseTotal()} as sequence
*
* @param api
* Current JDA instance
*/
public Event(@Nonnull JDA api)
{
this(api, api.getResponseTotal());
}
@Nonnull
@Override
public JDA getJDA()
{
return api;
}
@Override
public long getResponseNumber()
{
return responseNumber;
}
}