BukkitConverters (ProtocolLib JavaDocs)

java.lang.Object
- com.comphenix.protocol.wrappers.BukkitConverters

```
public class BukkitConverters
extends Object
```
Contains several useful equivalent converters for normal Bukkit types.

Author:

Kristian

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BukkitConverters.IgnoreNullConverter<TType>
Represents a typical equivalence converter.

Nested Classes
Modifier and Type	Class and Description
`static class`	`BukkitConverters.IgnoreNullConverter<TType>` Represents a typical equivalence converter.

Constructor Summary

Constructors
Constructor and Description

BukkitConverters()

Constructors
Constructor and Description
`BukkitConverters()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static PacketConstructor.Unwrapper`	`asUnwrapper(Class<?> nativeType, EquivalentConverter<Object> converter)` Retrieve an equivalent unwrapper for the converter.
`static <T> EquivalentConverter<Iterable<? extends T>>`	`getArrayConverter(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 EquivalentConverter<Integer>`	`getBlockIDConverter()` Deprecated. ID's are deprecated
`static Map<Class<?>,EquivalentConverter<Object>>`	`getConvertersForGeneric()` Retrieve every converter that is associated with a generic class.
`static Map<Class<?>,EquivalentConverter<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.potion.PotionEffectType>`	`getEffectTypeConverter()`
`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<List<T>>`	`getListConverter(Class<?> genericItemType, EquivalentConverter<T> itemConverter)` Retrieve an equivalent converter for a list of generic items.
`static <T,U> EquivalentConverter<Map<T,U>>`	`getMapConverter(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 <T> EquivalentConverter<Set<T>>`	`getSetConverter(Class<?> genericItemType, EquivalentConverter<T> itemConverter)` Retrieve an equivalent converter for a set of generic items.
`static EquivalentConverter<org.bukkit.Sound>`	`getSoundConverter()`
`static List<PacketConstructor.Unwrapper>`	`getUnwrappers()` Retrieve every NMS to/from Bukkit converter as unwrappers.
`static EquivalentConverter<org.bukkit.util.Vector>`	`getVectorConverter()` Retrieve the converter used to convert between a Vector and the equivalent NMS Vec3d.
`static EquivalentConverter<WrappedWatchableObject>`	`getWatchableObjectConverter()` Retrieve a converter for watchable objects and the respective wrapper.
`static EquivalentConverter<org.bukkit.World>`	`getWorldConverter()` Retrieve the converter used to convert between a NMS World and a Bukkit world.
`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<WrappedBlockData>`	`getWrappedBlockDataConverter()` Retrieve a converter for wrapped block data.
`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<Map<T,U>> getMapConverter(Class<?> genericKeyType,
                                                                  EquivalentConverter<T> keyConverter)
```
    Retrieve an equivalent converter for a map of generic keys and primitive values.
    
    Type Parameters:
    
    T - Key type
    
    U - Value type
    
    Parameters:
    
    genericKeyType - - the generic key type.
    
    keyConverter - - an equivalent converter for the generic type.
    
    Returns:
    
    An equivalent converter.
  - getListConverter
```
public static <T> EquivalentConverter<List<T>> getListConverter(Class<?> genericItemType,
                                                                EquivalentConverter<T> itemConverter)
```
    Retrieve an equivalent converter for a list of generic items.
    
    Type Parameters:
    
    T - Type
    
    Parameters:
    
    genericItemType - - the generic item type.
    
    itemConverter - - an equivalent converter for the generic type.
    
    Returns:
    
    An equivalent converter.
  - getSetConverter
```
public static <T> EquivalentConverter<Set<T>> getSetConverter(Class<?> genericItemType,
                                                              EquivalentConverter<T> itemConverter)
```
    Retrieve an equivalent converter for a set of generic items.
    
    Type Parameters:
    
    T - Type
    
    Parameters:
    
    genericItemType - - the generic item type.
    
    itemConverter - - an equivalent converter for the generic type.
    
    Returns:
    
    An equivalent converter.
  - getArrayConverter
```
public static <T> EquivalentConverter<Iterable<? extends T>> getArrayConverter(Class<?> genericItemType,
                                                                               EquivalentConverter<T> itemConverter)
```
    Retrieve an equivalent converter for an array of generic items.
    
    Type Parameters:
    
    T - Type
    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 component.
  - getWrappedBlockDataConverter
```
public static EquivalentConverter<WrappedBlockData> getWrappedBlockDataConverter()
```
    Retrieve a converter for wrapped block data.
    
    Returns:
    
    Wrapped block data.
  - 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.
  - getBlockIDConverter
```
@Deprecated
public static EquivalentConverter<Integer> getBlockIDConverter()
```
    Deprecated. ID's are deprecated
  - getWorldConverter
```
public static EquivalentConverter<org.bukkit.World> getWorldConverter()
```
    Retrieve the converter used to convert between a NMS World and a Bukkit world.
    
    Returns:
    
    The world converter.
  - 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.
  - getVectorConverter
```
public static EquivalentConverter<org.bukkit.util.Vector> getVectorConverter()
```
    Retrieve the converter used to convert between a Vector and the equivalent NMS Vec3d.
    
    Returns:
    
    The Vector converter.
  - getSoundConverter
```
public static EquivalentConverter<org.bukkit.Sound> getSoundConverter()
```
  - getIgnoreNull
```
public static <TType> EquivalentConverter<TType> getIgnoreNull(EquivalentConverter<TType> delegate)
```
    Wraps a given equivalent converter in NULL checks, ensuring that such values are ignored.
    
    Type Parameters:
    
    TType - Type
    
    Parameters:
    
    delegate - - the underlying equivalent converter.
    
    Returns:
    
    A equivalent converter that ignores NULL values.
  - asUnwrapper
```
public static PacketConstructor.Unwrapper asUnwrapper(Class<?> nativeType,
                                                      EquivalentConverter<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 Map<Class<?>,EquivalentConverter<Object>> getConvertersForSpecific()
```
    Retrieve every converter that is associated with a specific class.
    
    Returns:
    
    Every converter with a unique specific class.
  - getConvertersForGeneric
```
public static Map<Class<?>,EquivalentConverter<Object>> getConvertersForGeneric()
```
    Retrieve every converter that is associated with a generic class.
    
    Returns:
    
    Every converter with a unique generic class.
  - getUnwrappers
```
public static List<PacketConstructor.Unwrapper> getUnwrappers()
```
    Retrieve every NMS to/from Bukkit converter as unwrappers.
    
    Returns:
    
    Every unwrapper.
  - getEffectTypeConverter
```
public static EquivalentConverter<org.bukkit.potion.PotionEffectType> getEffectTypeConverter()
```

Class BukkitConverters

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BukkitConverters

Method Detail

getMapConverter

getListConverter

getSetConverter

getArrayConverter

getWrappedGameProfileConverter

getWrappedChatComponentConverter

getWrappedBlockDataConverter

getWrappedAttributeConverter

getWatchableObjectConverter

getDataWatcherConverter

getWorldTypeConverter

getNbtConverter

getEntityConverter

getItemStackConverter

getWrappedServerPingConverter

getWrappedStatisticConverter

getBlockConverter

getBlockIDConverter

getWorldConverter

getPotionEffectConverter

getVectorConverter

getSoundConverter

getIgnoreNull

asUnwrapper

getConvertersForSpecific

getConvertersForGeneric

getUnwrappers

getEffectTypeConverter