com.comphenix.protocol.wrappers

Class BukkitConverters

java.lang.Object

com.comphenix.protocol.wrappers.BukkitConverters

public class BukkitConverters
extends java.lang.Object

Contains several useful equivalent converters for normal Bukkit types.

Author:

Kristian

Constructor Summary

Constructors

Constructor and Description
BukkitConverters()

Method Summary

Methods

Modifier and Type	Method and Description
static PacketConstructor.Unwrapper	asUnwrapper(java.lang.Class<?> nativeType, EquivalentConverter<java.lang.Object> converter) Retrieve an equivalent unwrapper for the converter.
static <T> EquivalentConverter<java.lang.Iterable<? extends T>>	getArrayConverter(java.lang.Class<?> genericItemType, EquivalentConverter<T> itemConverter) Retrieve an equivalent converter for an array of generic items.
static EquivalentConverter<org.bukkit.Material>	getBlockConverter() Retrieve a converter for block instances.
static java.util.Map<java.lang.Class<?>,EquivalentConverter<java.lang.Object>>	getConvertersForGeneric() Retrieve every converter that is associated with a generic class.
static java.util.Map<java.lang.Class<?>,EquivalentConverter<java.lang.Object>>	getConvertersForSpecific() Retrieve every converter that is associated with a specific class.
static EquivalentConverter<WrappedDataWatcher>	getDataWatcherConverter() Retrieve a converter for the NMS DataWatcher class and our wrapper.
static EquivalentConverter<org.bukkit.entity.Entity>	getEntityConverter(org.bukkit.World world) Retrieve a converter for NMS entities and Bukkit entities.
static <TType> EquivalentConverter<TType>	getIgnoreNull(EquivalentConverter<TType> delegate) Wraps a given equivalent converter in NULL checks, ensuring that such values are ignored.
static EquivalentConverter<org.bukkit.inventory.ItemStack>	getItemStackConverter() Retrieve the converter used to convert NMS ItemStacks to Bukkit's ItemStack.
static <T> EquivalentConverter<java.util.List<T>>	getListConverter(java.lang.Class<?> genericItemType, EquivalentConverter<T> itemConverter) Retrieve an equivalent converter for a list of generic items.
static <T,U> EquivalentConverter<java.util.Map<T,U>>	getMapConverter(java.lang.Class<?> genericKeyType, EquivalentConverter<T> keyConverter) Retrieve an equivalent converter for a map of generic keys and primitive values.
static EquivalentConverter<NbtBase<?>>	getNbtConverter() Retrieve an equivalent converter for net.minecraft.server NBT classes and their wrappers.
static EquivalentConverter<org.bukkit.potion.PotionEffect>	getPotionEffectConverter() Retrieve the converter used to convert between a PotionEffect and the equivalent NMS Mobeffect.
static java.util.List<PacketConstructor.Unwrapper>	getUnwrappers() Retrieve every NMS <-> Bukkit converter as unwrappers.
static EquivalentConverter<WrappedWatchableObject>	getWatchableObjectConverter() Retrieve a converter for watchable objects and the respective wrapper.
static EquivalentConverter<org.bukkit.WorldType>	getWorldTypeConverter() Retrieve a converter for Bukkit's world type enum and the NMS equivalent.
static EquivalentConverter<WrappedAttribute>	getWrappedAttributeConverter() Retrieve a converter for wrapped attribute snapshots.
static EquivalentConverter<WrappedChatComponent>	getWrappedChatComponentConverter() Retrieve a converter for wrapped chat components.
static EquivalentConverter<WrappedGameProfile>	getWrappedGameProfileConverter() Retrieve a converter for wrapped attribute snapshots.
static EquivalentConverter<WrappedServerPing>	getWrappedServerPingConverter() Retrieve the converter for the ServerPing packet in PacketType.Status.Server#OUT_SERVER_INFO.
static EquivalentConverter<WrappedStatistic>	getWrappedStatisticConverter() Retrieve the converter for a statistic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BukkitConverters

public BukkitConverters()

Method Detail

getMapConverter

public static <T,U> EquivalentConverter<java.util.Map<T,U>> getMapConverter(java.lang.Class<?> genericKeyType,
                                                            EquivalentConverter<T> keyConverter)

Retrieve an equivalent converter for a map of generic keys and primitive values.

Parameters:

genericItemType - - the generic item type.

itemConverter - - an equivalent converter for the generic type.

Returns:

An equivalent converter.

getListConverter

public static <T> EquivalentConverter<java.util.List<T>> getListConverter(java.lang.Class<?> genericItemType,
                                                          EquivalentConverter<T> itemConverter)

Retrieve an equivalent converter for a list of generic items.

Parameters:

genericItemType - - the generic item type.

itemConverter - - an equivalent converter for the generic type.

Returns:

An equivalent converter.

getArrayConverter

public static <T> EquivalentConverter<java.lang.Iterable<? extends T>> getArrayConverter(java.lang.Class<?> genericItemType,
                                                                         EquivalentConverter<T> itemConverter)

Retrieve an equivalent converter for an array of generic items.

The array is wrapped in a list.

Parameters:

genericItemType - - the generic item type.

itemConverter - - an equivalent converter for the generic type.

Returns:

An equivalent converter.

getWrappedGameProfileConverter

public static EquivalentConverter<WrappedGameProfile> getWrappedGameProfileConverter()

Retrieve a converter for wrapped attribute snapshots.

Returns:

Wrapped attribute snapshot converter.

getWrappedChatComponentConverter

public static EquivalentConverter<WrappedChatComponent> getWrappedChatComponentConverter()

Retrieve a converter for wrapped chat components.

Returns:

Wrapped chat componetns.

getWrappedAttributeConverter

public static EquivalentConverter<WrappedAttribute> getWrappedAttributeConverter()

Retrieve a converter for wrapped attribute snapshots.

Returns:

Wrapped attribute snapshot converter.

getWatchableObjectConverter

public static EquivalentConverter<WrappedWatchableObject> getWatchableObjectConverter()

Retrieve a converter for watchable objects and the respective wrapper.

Returns:

A watchable object converter.

getDataWatcherConverter

public static EquivalentConverter<WrappedDataWatcher> getDataWatcherConverter()

Retrieve a converter for the NMS DataWatcher class and our wrapper.

Returns:

A DataWatcher converter.

getWorldTypeConverter

public static EquivalentConverter<org.bukkit.WorldType> getWorldTypeConverter()

Retrieve a converter for Bukkit's world type enum and the NMS equivalent.

Returns:

A world type enum converter.

getNbtConverter

public static EquivalentConverter<NbtBase<?>> getNbtConverter()

Retrieve an equivalent converter for net.minecraft.server NBT classes and their wrappers.

Returns:

An equivalent converter for NBT.

getEntityConverter

public static EquivalentConverter<org.bukkit.entity.Entity> getEntityConverter(org.bukkit.World world)

Retrieve a converter for NMS entities and Bukkit entities.

Parameters:

world - - the current world.

Returns:

A converter between the underlying NMS entity and Bukkit's wrapper.

getItemStackConverter

public static EquivalentConverter<org.bukkit.inventory.ItemStack> getItemStackConverter()

Retrieve the converter used to convert NMS ItemStacks to Bukkit's ItemStack.

Returns:

Item stack converter.

getWrappedServerPingConverter

public static EquivalentConverter<WrappedServerPing> getWrappedServerPingConverter()

Retrieve the converter for the ServerPing packet in PacketType.Status.Server#OUT_SERVER_INFO.

Returns:

Server ping converter.

getWrappedStatisticConverter

public static EquivalentConverter<WrappedStatistic> getWrappedStatisticConverter()

Retrieve the converter for a statistic.

Returns:

Statistic converter.

getBlockConverter

public static EquivalentConverter<org.bukkit.Material> getBlockConverter()

Retrieve a converter for block instances.

Returns:

A converter for block instances.

getPotionEffectConverter

public static EquivalentConverter<org.bukkit.potion.PotionEffect> getPotionEffectConverter()

Retrieve the converter used to convert between a PotionEffect and the equivalent NMS Mobeffect.

Returns:

The potion effect converter.

getIgnoreNull

public static <TType> EquivalentConverter<TType> getIgnoreNull(EquivalentConverter<TType> delegate)

Wraps a given equivalent converter in NULL checks, ensuring that such values are ignored.

Parameters:

delegate - - the underlying equivalent converter.

Returns:

A equivalent converter that ignores NULL values.

asUnwrapper

public static PacketConstructor.Unwrapper asUnwrapper(java.lang.Class<?> nativeType,
                                      EquivalentConverter<java.lang.Object> converter)

Retrieve an equivalent unwrapper for the converter.

Parameters:

nativeType - - the native NMS type the converter produces.

converter - - the converter.

Returns:

The equivalent unwrapper.

getConvertersForSpecific

public static java.util.Map<java.lang.Class<?>,EquivalentConverter<java.lang.Object>> getConvertersForSpecific()

Retrieve every converter that is associated with a specific class.

Returns:

Every converter with a unique specific class.

getConvertersForGeneric

public static java.util.Map<java.lang.Class<?>,EquivalentConverter<java.lang.Object>> getConvertersForGeneric()

Retrieve every converter that is associated with a generic class.

Returns:

Every converter with a unique generic class.

getUnwrappers

public static java.util.List<PacketConstructor.Unwrapper> getUnwrappers()

Retrieve every NMS <-> Bukkit converter as unwrappers.

Returns:

Every unwrapper.