Package com.comphenix.protocol.wrappers

Class AutoWrapper<T>

java.lang.Object

com.comphenix.protocol.wrappers.AutoWrapper<T>

All Implemented Interfaces:

EquivalentConverter<T>

public class AutoWrapper<T>
extends Object
implements EquivalentConverter<T>

Automatically wraps an internal NMS class to a non-versioned, deofbuscated class. Requirements:

• The wrapper must be public
• If the wrapper is an internal class, it must be static
• The wrapper must have one public constructor with no arguments (the default constructor is acceptable)
• The wrapper must have the the same number of fields as the NMS class
• Each field should correspond, in order, to its NMS counterpart
• Non-generic fields must have a converter

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AutoWrapper.InvalidWrapperException

Method Summary

Modifier and Type	Method	Description
AutoWrapper<T>	field(int index, EquivalentConverter converter)
AutoWrapper<T>	field(int index, Function<Object,Object> wrapper, Function<Object,Object> unwrapper)
Object	getGeneric(Object specific)	Retrieve a copy of the generic type from a specific type.
T	getSpecific(Object generic)	Retrieve a copy of the specific type using an instance of the generic type.
Class<T>	getSpecificType()	Due to type erasure, we need to explicitly keep a reference to the specific type.
Object	unwrap(Object wrapper)
static <T> AutoWrapper<T>	wrap(Class<T> wrapperClass, Class<?> nmsClass)
static <T> AutoWrapper<T>	wrap(Class<T> wrapperClass, String nmsClassName)
static <T> AutoWrapper<T>	wrap(Class<T> wrapperClass, String nmsClassName, String... aliases)
T	wrap(Object nmsObject)

Methods inherited from class java.lang.Object

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

Method Details

wrap

public static <T> AutoWrapper<T> wrap(Class<T> wrapperClass,
 Class<?> nmsClass)

wrap

public static <T> AutoWrapper<T> wrap(Class<T> wrapperClass,
 String nmsClassName)

wrap

public static <T> AutoWrapper<T> wrap(Class<T> wrapperClass,
 String nmsClassName,
 String... aliases)

field

public AutoWrapper<T> field(int index,
 Function<Object,Object> wrapper,
 Function<Object,Object> unwrapper)

field

public AutoWrapper<T> field(int index,
 EquivalentConverter converter)

wrap

public T wrap(Object nmsObject)

unwrap

public Object unwrap(Object wrapper)

getSpecific

public T getSpecific(Object generic)

Description copied from interface: EquivalentConverter

Retrieve a copy of the specific type using an instance of the generic type.

This is usually a wrapper type in the Bukkit API or ProtocolLib API.

Specified by:

getSpecific in interface EquivalentConverter<T>

Parameters:

generic - - the generic type.

Returns:

The new specific type.

getGeneric

public Object getGeneric(Object specific)

Description copied from interface: EquivalentConverter

Retrieve a copy of the generic type from a specific type.

This is usually a native net.minecraft.server type in Minecraft.

Specified by:

getGeneric in interface EquivalentConverter<T>

Parameters:

specific - - the specific type we need to copy.

Returns:

A copy of the specific type.

getSpecificType

public Class<T> getSpecificType()

Description copied from interface: EquivalentConverter

Due to type erasure, we need to explicitly keep a reference to the specific type.

Specified by:

getSpecificType in interface EquivalentConverter<T>

Returns:

The specific type.