mirror of
https://github.com/proxiodev/RedisBungee.git
synced 2026-04-08 16:10:26 +00:00
added some javadocs info + added jedis summoner class for future release
This commit is contained in:
@@ -0,0 +1,32 @@
|
||||
package com.imaginarycode.minecraft.redisbungee;
|
||||
|
||||
/**
|
||||
* This used to be old plugin instance of redis-bungee but now its used to get the api for old plugins
|
||||
*
|
||||
* @deprecated its deprecated but won't be removed, so please use {@link RedisBungeeAPI#getRedisBungeeApi()}
|
||||
*
|
||||
*/
|
||||
@Deprecated
|
||||
public class RedisBungee {
|
||||
|
||||
private static RedisBungeeAPI api;
|
||||
|
||||
public RedisBungee(RedisBungeeAPI api) {
|
||||
RedisBungee.api = api;
|
||||
}
|
||||
|
||||
/**
|
||||
* This returns instance of {@link RedisBungeeAPI}
|
||||
*
|
||||
* @deprecated Please use {@link RedisBungeeAPI#getRedisBungeeApi()} this class intended to for old plugins that no longer updated.
|
||||
*
|
||||
* @return the {@link RedisBungeeAPI} object instance.
|
||||
*/
|
||||
@Deprecated
|
||||
public static RedisBungeeAPI getApi() {
|
||||
return api;
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
@@ -14,8 +14,9 @@ import java.net.InetAddress;
|
||||
import java.util.*;
|
||||
|
||||
/**
|
||||
* This class exposes some internal RedisBungee functions. You obtain an instance of this object by invoking {@link RedisBungeePlugin#getApi()}.
|
||||
*
|
||||
* This class exposes some internal RedisBungee functions. You obtain an instance of this object by invoking {@link RedisBungeeAPI#getRedisBungeeApi()}
|
||||
* or somehow you got the Plugin instance by you can call the api using {@link RedisBungeePlugin#getApi()}.
|
||||
* or
|
||||
* @author tuxed
|
||||
* @since 0.2.3
|
||||
*
|
||||
|
||||
@@ -0,0 +1,19 @@
|
||||
package com.imaginarycode.minecraft.redisbungee.internal;
|
||||
|
||||
import redis.clients.jedis.Jedis;
|
||||
|
||||
|
||||
/**
|
||||
* This class intended for future release to support redis sentinel or redis clusters
|
||||
*
|
||||
* @author Ham1255
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
public interface JedisSummoner {
|
||||
|
||||
Jedis requestJedis();
|
||||
|
||||
boolean isJedisAvailable();
|
||||
|
||||
}
|
||||
@@ -7,7 +7,6 @@ import com.imaginarycode.minecraft.redisbungee.events.PlayerJoinedNetworkEvent;
|
||||
import com.imaginarycode.minecraft.redisbungee.events.PlayerLeftNetworkEvent;
|
||||
import com.imaginarycode.minecraft.redisbungee.events.PubSubMessageEvent;
|
||||
import com.imaginarycode.minecraft.redisbungee.internal.util.uuid.UUIDTranslator;
|
||||
import redis.clients.jedis.Jedis;
|
||||
|
||||
import java.net.InetAddress;
|
||||
import java.util.List;
|
||||
@@ -15,7 +14,16 @@ import java.util.Set;
|
||||
import java.util.UUID;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
public interface RedisBungeePlugin<P> {
|
||||
|
||||
|
||||
/**
|
||||
* This Class has all internal methods needed by every redis bungee plugin, and it can be used to implement another platforms than bungeecord
|
||||
*
|
||||
* @author Ham1255
|
||||
* @since 0.7.0
|
||||
*
|
||||
*/
|
||||
public interface RedisBungeePlugin<P> extends JedisSummoner {
|
||||
|
||||
default void enable() {
|
||||
|
||||
@@ -37,10 +45,6 @@ public interface RedisBungeePlugin<P> {
|
||||
|
||||
Set<UUID> getPlayers();
|
||||
|
||||
Jedis requestJedis();
|
||||
|
||||
boolean isJedisAvailable();
|
||||
|
||||
RedisBungeeAPI getApi();
|
||||
|
||||
UUIDTranslator getUuidTranslator();
|
||||
|
||||
Reference in New Issue
Block a user