Package org.bukkit.inventory.meta.tags

Interface ItemTagType<T,Z>

Type Parameters:

T - the primary object type that is stored in the given tag

Z - the retrieved object type when applying this item tag type

All Known Implementing Classes:

ItemTagType.PrimitiveTagType

Deprecated.

please use PersistentDataType as this part of the api is being replaced

@Deprecated
public interface ItemTagType<T,Z>

This class represents an enum with a generic content type. It defines the types a custom item tag can have.

This interface can be used to create your own custom ItemTagType with different complex types. This may be useful for the likes of a UUIDItemTagType:

 
 public class UUIDItemTagType implements ItemTagType<byte[], UUID> {

         {@literal @Override}
         public Class<byte[]> getPrimitiveType() {
             return byte[].class;
         }

         {@literal @Override}
         public Class<UUID> getComplexType() {
             return UUID.class;
         }

         {@literal @Override}
         public byte[] toPrimitive(UUID complex, ItemTagAdapterContext context) {
             ByteBuffer bb = ByteBuffer.wrap(new byte[16]);
             bb.putLong(complex.getMostSignificantBits());
             bb.putLong(complex.getLeastSignificantBits());
             return bb.array();
         }

         {@literal @Override}
         public UUID fromPrimitive(byte[] primitive, ItemTagAdapterContext context) {
             ByteBuffer bb = ByteBuffer.wrap(primitive);
             long firstLong = bb.getLong();
             long secondLong = bb.getLong();
             return new UUID(firstLong, secondLong);
         }
     }

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ItemTagType.PrimitiveTagType<T>	Deprecated. A default implementation that simply exists to pass on the retrieved or inserted value to the next layer.

Field Summary

Fields

Modifier and Type	Field	Description
static ItemTagType<Byte,Byte>	BYTE	Deprecated.
static ItemTagType<byte[],byte[]>	BYTE_ARRAY	Deprecated.
static ItemTagType<Double,Double>	DOUBLE	Deprecated.
static ItemTagType<Float,Float>	FLOAT	Deprecated.
static ItemTagType<Integer,Integer>	INTEGER	Deprecated.
static ItemTagType<int[],int[]>	INTEGER_ARRAY	Deprecated.
static ItemTagType<Long,Long>	LONG	Deprecated.
static ItemTagType<long[],long[]>	LONG_ARRAY	Deprecated.
static ItemTagType<Short,Short>	SHORT	Deprecated.
static ItemTagType<String,String>	STRING	Deprecated.
static ItemTagType<CustomItemTagContainer,CustomItemTagContainer>	TAG_CONTAINER	Deprecated.

Method Summary

Modifier and Type	Method	Description
Z	fromPrimitive(T primitive, ItemTagAdapterContext context)	Deprecated. Creates a complex object based of the passed primitive value
Class<Z>	getComplexType()	Deprecated. Returns the complex object type the primitive value resembles.
Class<T>	getPrimitiveType()	Deprecated. Returns the primitive data type of this tag.
T	toPrimitive(Z complex, ItemTagAdapterContext context)	Deprecated. Returns the primitive data that resembles the complex object passed to this method.

Field Detail

BYTE

static final ItemTagType<Byte,Byte> BYTE

Deprecated.

SHORT

static final ItemTagType<Short,Short> SHORT

Deprecated.

INTEGER

static final ItemTagType<Integer,Integer> INTEGER

Deprecated.

LONG

static final ItemTagType<Long,Long> LONG

Deprecated.

FLOAT

static final ItemTagType<Float,Float> FLOAT

Deprecated.

DOUBLE

static final ItemTagType<Double,Double> DOUBLE

Deprecated.

STRING

static final ItemTagType<String,String> STRING

Deprecated.

BYTE_ARRAY

static final ItemTagType<byte[],byte[]> BYTE_ARRAY

Deprecated.

INTEGER_ARRAY

static final ItemTagType<int[],int[]> INTEGER_ARRAY

Deprecated.

LONG_ARRAY

static final ItemTagType<long[],long[]> LONG_ARRAY

Deprecated.

TAG_CONTAINER

static final ItemTagType<CustomItemTagContainer,CustomItemTagContainer> TAG_CONTAINER

Deprecated.

Method Detail

getPrimitiveType

@NotNull
Class<T> getPrimitiveType()

Deprecated.

Returns the primitive data type of this tag.

Returns:

the class

getComplexType

@NotNull
Class<Z> getComplexType()

Deprecated.

Returns the complex object type the primitive value resembles.

Returns:

the class type

toPrimitive

@NotNull
T toPrimitive(@NotNull
              Z complex,
              @NotNull
              ItemTagAdapterContext context)

Deprecated.

Returns the primitive data that resembles the complex object passed to this method.

Parameters:

complex - the complex object instance

context - the context this operation is running in

Returns:

the primitive value

fromPrimitive

@NotNull
Z fromPrimitive(@NotNull
                T primitive,
                @NotNull
                ItemTagAdapterContext context)

Deprecated.

Creates a complex object based of the passed primitive value

Parameters:

primitive - the primitive value

context - the context this operation is running in

Returns:

the complex object instance