Adapter (common 2.5.1 API)

java.lang.Object
- com.elikill58.negativity.universal.Adapter

Direct Known Subclasses:: ProxyAdapter

public abstract class Adapter
extends Object

Constructor Summary

Constructors
Constructor and Description

Adapter()

Constructors
Constructor and Description
`Adapter()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract void`	`broadcastMessage(String message)` Broadcast the message to all online player, without any filter.
`boolean`	`canSendStats()` Check if can send stats
`abstract FakePlayer`	`createFakePlayer(Location loc, String name)` Create a fake player WARN: Not supported yet with all platform
`abstract Inventory`	`createInventory(String inventoryName, int size, NegativityHolder holder)` Create a new inventory
`abstract ItemBuilder`	`createItemBuilder(ItemStack item)` Create a new item builder with the given item
`abstract ItemBuilder`	`createItemBuilder(Material type)` Create a new item builder with the given type
`abstract ItemBuilder`	`createItemBuilder(String type)` Create a new item builder with the given type name
`abstract ItemBuilder`	`createSkullItemBuilder(OfflinePlayer owner)` Create a new item builder of skull with the current owner
`abstract ItemBuilder`	`createSkullItemBuilder(Player owner)` Create a new item builder of skull with the current owner
`void`	`debug(String msg)` Log this message if debug is enabled
`abstract NegativityAccountManager`	`getAccountManager()` Get the account manager of the platform
`static Adapter`	`getAdapter()`
`abstract List<String>`	`getAllPlugins()` Get all plugins on the actual platform.
`abstract Configuration`	`getConfig()` Get the Negativity's config of the platform
`abstract File`	`getDataFolder()` Get the data folder of the plugin
`abstract List<ExternalPlugin>`	`getDependentPlugins()`
`abstract ItemRegistrar`	`getItemRegistrar()` Get the registrar of all items
`abstract double`	`getLastTPS()` Get last TPS value
`abstract LoggerAdapter`	`getLogger()` Get a logger adapter to log informations.
`String`	`getName()` Get the platform name
`abstract @Nullable OfflinePlayer`	`getOfflinePlayer(String name)` Get offline player with the given name Prefer use `getOfflinePlayer(UUID)` because this method isn't supported on all platform, and a name can be changed
`abstract @Nullable OfflinePlayer`	`getOfflinePlayer(UUID uuid)` Get offline player with the given UUID
`abstract List<Player>`	`getOnlinePlayers()` Get all online players
`abstract List<UUID>`	`getOnlinePlayersUUID()` Get UUID of all online players
`abstract Platform`	`getPlatformID()` Get the platform
`abstract TranslationProviderFactory`	`getPlatformTranslationProviderFactory()`
`abstract @Nullable Player`	`getPlayer(String name)` Get player with the given name Prefer use `getPlayer(UUID)` because this method isn't supported on all platform, and a name can be changed
`abstract @Nullable Player`	`getPlayer(UUID uuid)` Get player with the given UUID
`abstract ExternalPlugin`	`getPlugin(String name)` Get another plugin
`abstract String`	`getPluginVersion()` Get the version of the Negativity plugin
`abstract Scheduler`	`getScheduler()`
`abstract Version`	`getServerVersion()` The Minecraft version the server is running
`abstract double[]`	`getTPS()` Get all available TPS This array is not empty, at least, it contains the `getLastTPS()` value in [0] place
`@Nullable UUID`	`getUUID(String name)` Get the UUID with the name
`abstract String`	`getVersion()` Get the platform version
`abstract VersionAdapter<?>`	`getVersionAdapter()` Get the version adapter for the actual platform version
`abstract boolean`	`hasPlugin(String name)` Check if another plugin is loaded.
`abstract void`	`registerNewIncomingChannel(String channel, BiConsumer<Player,byte[]> event)` Register incoming channel and call consumer when receiving new channel message
`abstract void`	`reload()` Reload Negativity's plugin
`abstract void`	`reloadConfig()` Reload the configuration of Negativity
`abstract void`	`runConsoleCommand(String cmd)` Run a command from console
`abstract void`	`runSync(Runnable call)` Run action sync with the server.
`abstract void`	`sendMessageRunnableHover(Player p, String message, String hover, String command)` Send message to the specified player which can run a command and have a message showed when the mouse is drag hover the message.
`static void`	`setAdapter(Adapter adapter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Adapter
```
public Adapter()
```
- Method Detail
  - setAdapter
```
public static void setAdapter(Adapter adapter)
```
  - getAdapter
```
public static Adapter getAdapter()
```
  - getPlatformID
```
public abstract Platform getPlatformID()
```
    Get the platform
    
    Returns:
    
    the platform
  - getName
```
public String getName()
```
    Get the platform name
    
    Returns:
    
    the platform name
  - getConfig
```
public abstract Configuration getConfig()
```
    Get the Negativity's config of the platform
    
    Returns:
    
    the Negativity configuration
  - getDataFolder
```
public abstract File getDataFolder()
```
    Get the data folder of the plugin
    
    Returns:
    
    the data folder
  - getLogger
```
public abstract LoggerAdapter getLogger()
```
    Get a logger adapter to log informations.
    
    Returns:
    
    the logger
  - debug
```
public void debug(String msg)
```
    Log this message if debug is enabled
    
    Parameters:
    
    msg - the message to log
  - getPlatformTranslationProviderFactory
```
public abstract TranslationProviderFactory getPlatformTranslationProviderFactory()
```
  - reload
```
public abstract void reload()
```
    Reload Negativity's plugin
  - getVersion
```
public abstract String getVersion()
```
    Get the platform version
    
    Returns:
    
    the platform version
  - getServerVersion
```
public abstract Version getServerVersion()
```
    The Minecraft version the server is running
    
    Returns:
    
    the version of the server
  - getPluginVersion
```
public abstract String getPluginVersion()
```
    Get the version of the Negativity plugin
    
    Returns:
    
    the version of Negativity
  - reloadConfig
```
public abstract void reloadConfig()
```
    Reload the configuration of Negativity
  - getAccountManager
```
public abstract NegativityAccountManager getAccountManager()
```
    Get the account manager of the platform
    
    Returns:
    
    the account manager
  - runConsoleCommand
```
public abstract void runConsoleCommand(String cmd)
```
    Run a command from console
    
    Parameters:
    
    cmd - the command which have to be execute
  - getOnlinePlayersUUID
```
public abstract List<UUID> getOnlinePlayersUUID()
```
    Get UUID of all online players
    
    Returns:
    
    online players UUID
  - getOnlinePlayers
```
public abstract List<Player> getOnlinePlayers()
```
    Get all online players
    
    Returns:
    
    all online players
  - getTPS
```
public abstract double[] getTPS()
```
    Get all available TPS This array is not empty, at least, it contains the getLastTPS() value in [0] place
    
    Returns:
    
    tps
  - getLastTPS
```
public abstract double getLastTPS()
```
    Get last TPS value
    
    Returns:
    
    last TPS
  - getItemRegistrar
```
public abstract ItemRegistrar getItemRegistrar()
```
    Get the registrar of all items
    
    Returns:
    
    the item registrar
  - createItemBuilder
```
public abstract ItemBuilder createItemBuilder(Material type)
```
    Create a new item builder with the given type
    
    Parameters:
    
    type - the item type
    
    Returns:
    
    a new item builder of itemstack with the given type
  - createItemBuilder
```
public abstract ItemBuilder createItemBuilder(ItemStack item)
```
    Create a new item builder with the given item
    
    Parameters:
    
    item - the beginning item
    
    Returns:
    
    a new item builder of itemstack with the given type
  - createItemBuilder
```
public abstract ItemBuilder createItemBuilder(String type)
```
    Create a new item builder with the given type name
    
    Parameters:
    
    type - the item type name
    
    Returns:
    
    a new item builder of itemstack with the given type name
  - createSkullItemBuilder
```
public abstract ItemBuilder createSkullItemBuilder(Player owner)
```
    Create a new item builder of skull with the current owner
    
    Parameters:
    
    owner - the player owner of the skull
    
    Returns:
    
    an item builder of the skull
  - createSkullItemBuilder
```
public abstract ItemBuilder createSkullItemBuilder(OfflinePlayer owner)
```
    Create a new item builder of skull with the current owner
    
    Parameters:
    
    owner - the player owner of the skull
    
    Returns:
    
    an item builder of the skull
  - createInventory
```
public abstract Inventory createInventory(String inventoryName,
                                          int size,
                                          NegativityHolder holder)
```
    Create a new inventory
    
    Parameters:
    
    inventoryName - the inventory name
    
    size - the inventory size
    
    holder - the inventory holder
    
    Returns:
    
    a new inventory
  - getUUID
```
public @Nullable UUID getUUID(String name)
```
    Get the UUID with the name
    
    Parameters:
    
    name - the name of a possible player
    
    Returns:
    
    the uuid of the player or null if can't find
  - getOfflinePlayer
```
public abstract @Nullable OfflinePlayer getOfflinePlayer(String name)
```
    Get offline player with the given name Prefer use getOfflinePlayer(UUID) because this method isn't supported on all platform, and a name can be changed
    
    Parameters:
    
    name - the offline player name
    
    Returns:
    
    the offline player, or null if no player matching this name has played on this server
  - getOfflinePlayer
```
public abstract @Nullable OfflinePlayer getOfflinePlayer(UUID uuid)
```
    Get offline player with the given UUID
    
    Parameters:
    
    uuid - the offline player UUID
    
    Returns:
    
    the offline player, or null if no player with this UUID has played on this server
  - getPlayer
```
public abstract @Nullable Player getPlayer(String name)
```
    Get player with the given name Prefer use getPlayer(UUID) because this method isn't supported on all platform, and a name can be changed
    
    Parameters:
    
    name - the player name
    
    Returns:
    
    the player, or null if no player matching this name is online
  - getPlayer
```
public abstract @Nullable Player getPlayer(UUID uuid)
```
    Get player with the given UUID
    
    Parameters:
    
    uuid - the player UUID
    
    Returns:
    
    the player, or null if no player with this UUID is online
  - createFakePlayer
```
public abstract FakePlayer createFakePlayer(Location loc,
                                            String name)
```
    Create a fake player WARN: Not supported yet with all platform
    
    Parameters:
    
    loc - the location of the fake player
    
    name - the name of the fake player
    
    Returns:
    
    the fake player
  - sendMessageRunnableHover
```
public abstract void sendMessageRunnableHover(Player p,
                                              String message,
                                              String hover,
                                              String command)
```
    Send message to the specified player which can run a command and have a message showed when the mouse is drag hover the message.
    
    Parameters:
    
    p - the player that will receive the message
    
    message - the message
    
    hover - the hover message (show on mouse drag)
    
    command - the command run on click
  - hasPlugin
```
public abstract boolean hasPlugin(String name)
```
    Check if another plugin is loaded.
    
    Parameters:
    
    name - the plugin name (used by the platform)
    
    Returns:
    
    true if the plugin is loaded.
  - getPlugin
```
public abstract ExternalPlugin getPlugin(String name)
```
    Get another plugin
    
    Parameters:
    
    name - the plugin name (used by the platform)
    
    Returns:
    
    the external plugin or null if not found
  - getDependentPlugins
```
public abstract List<ExternalPlugin> getDependentPlugins()
```
    Returns:
    
    all plugins depending on Negativity
  - runSync
```
public abstract void runSync(Runnable call)
```
    Run action sync with the server. Specially useful for world/player action
    
    Parameters:
    
    call - the action to call
  - getScheduler
```
public abstract Scheduler getScheduler()
```
    Returns:
    
    a synchronous scheduler that can be used to schedule task on the server thread.
  - canSendStats
```
public boolean canSendStats()
```
    Check if can send stats
    
    Returns:
    
    true is can send stats
  - registerNewIncomingChannel
```
public abstract void registerNewIncomingChannel(String channel,
                                                BiConsumer<Player,byte[]> event)
```
    Register incoming channel and call consumer when receiving new channel message
    
    Parameters:
    
    channel - the channel name
    
    event - The callable event which will be fired when received message from this channel
  - broadcastMessage
```
public abstract void broadcastMessage(String message)
```
    Broadcast the message to all online player, without any filter.
    
    Parameters:
    
    message - the message to send
  - getAllPlugins
```
public abstract List<String> getAllPlugins()
```
    Get all plugins on the actual platform.
    
    Returns:
    
    all plugins names
  - getVersionAdapter
```
public abstract VersionAdapter<?> getVersionAdapter()
```
    Get the version adapter for the actual platform version
    
    Returns:
    
    the version adapter

Class Adapter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Adapter

Method Detail

setAdapter

getAdapter

getPlatformID

getName

getConfig

getDataFolder

getLogger

debug

getPlatformTranslationProviderFactory

reload

getVersion

getServerVersion

getPluginVersion

reloadConfig

getAccountManager

runConsoleCommand

getOnlinePlayersUUID

getOnlinePlayers

getTPS

getLastTPS

getItemRegistrar

createItemBuilder

createItemBuilder

createItemBuilder

createSkullItemBuilder

createSkullItemBuilder

createInventory

getUUID

getOfflinePlayer

getOfflinePlayer

getPlayer

getPlayer

createFakePlayer

sendMessageRunnableHover

hasPlugin

getPlugin

getDependentPlugins

runSync

getScheduler

canSendStats

registerNewIncomingChannel

broadcastMessage

getAllPlugins

getVersionAdapter