TagFactory (core API)

java.lang.Object
- io.github.mrblobman.nbt.TagFactory

```
public abstract class TagFactory
extends java.lang.Object
```
A TagFactory is the class that links the version independent classes to the version dependent ones. It creates proxies wrapping the version dependent nms classes. These proxies delegate actions to their nms handle. See NBTBaseTag for this basic interaction.

Constructor Summary

Constructors
Constructor and Description

TagFactory()

Constructors
Constructor and Description
`TagFactory()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static TagFactory`	`get()` Get the instance of a `TagFactory` that supports the current server version.
`abstract NBTIODelegate<org.bukkit.block.BlockState>`	`getBlockIODelegate()` NOTE: This delegate must assume that any `BlockState`s given to it are tile entities! There is no exposed interface in Spigot for the sub set of BlockStates that are tile entities so it is left to the caller to ensure this safety.
`abstract NBTIODelegate<org.bukkit.entity.Entity>`	`getEntityIODelegate()`
`abstract NBTIODelegate<java.io.File>`	`getFileIODelegate()` Warning: Reading an empty tag will throw an exception.
`abstract NBTIODelegate<org.bukkit.inventory.ItemStack>`	`getItemIODelegate()`
`abstract NBTBaseTag<byte[]>`	`newByteArrayTag(byte[] value)` Wrap the value in a byte[] tag.
`abstract NBTBaseTag<java.lang.Byte>`	`newByteTag(byte value)` Wrap the value in a byte tag.
`abstract NBTCompoundTag`	`newCompoundTag()` Create an empty compound tag.
`abstract NBTBaseTag<java.lang.Double>`	`newDoubleTag(double value)` Wrap the value in a double tag.
`abstract NBTBaseTag<java.lang.Float>`	`newFloatTag(float value)` Wrap the value in a float tag.
`abstract NBTBaseTag<int[]>`	`newIntArrayTag(int[] value)` Wrap the value in a int[] tag.
`abstract NBTBaseTag<java.lang.Integer>`	`newIntTag(int value)` Wrap the value in a int tag.
`abstract NBTListTag`	`newListTag()` Create an empty list tag.
`abstract NBTBaseTag<java.lang.Long>`	`newLongTag(long value)` Wrap the value in a long tag.
`abstract NBTBaseTag<java.lang.Short>`	`newShortTag(short value)` Wrap the value in a short tag.
`abstract NBTBaseTag<java.lang.String>`	`newStringTag(java.lang.String value)` Wrap the value in a String tag.
`abstract NBTCompoundTag`	`parse(java.lang.String serialized)` Parse the serialized form of the tag and try to build its data representation.

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

- Constructor Detail
  - TagFactory
```
public TagFactory()
```
- Method Detail
  - get
```
public static TagFactory get()
```
    Get the instance of a TagFactory that supports the current server version.
    
    Returns:
    
    the appropriate instance for the current server version
    
    Throws:
    
    java.lang.UnsupportedOperationException - if there is no support for the current version.
  - getItemIODelegate
```
public abstract NBTIODelegate<org.bukkit.inventory.ItemStack> getItemIODelegate()
```
    Returns:
    
    the NBTIODelegate for ItemStack IO tasks.
  - getEntityIODelegate
```
public abstract NBTIODelegate<org.bukkit.entity.Entity> getEntityIODelegate()
```
    Returns:
    
    the NBTIODelegate for Entity IO tasks.
  - getBlockIODelegate
```
public abstract NBTIODelegate<org.bukkit.block.BlockState> getBlockIODelegate()
```
    NOTE: This delegate must assume that any BlockStates given to it are tile entities! There is no exposed interface in Spigot for the sub set of BlockStates that are tile entities so it is left to the caller to ensure this safety.
    
    Returns:
    
    the NBTIODelegate for BlockState IO tasks.
  - getFileIODelegate
```
public abstract NBTIODelegate<java.io.File> getFileIODelegate()
```
    Warning: Reading an empty tag will throw an exception. You should put something in the tag before saving it or skip the save if there is no data to write.
    
    Returns:
    
    the NBTIODelegate for File IO tasks.
  - parse
```
public abstract NBTCompoundTag parse(java.lang.String serialized)
                              throws NBTException
```
    Parse the serialized form of the tag and try to build its data representation. This is useful for obtaining NBT tags as command line arguments. The NBTTag grammar is as follows:
```
     nbt_tag := nbt_compound | nbt_list | nbt_primitive ;

     nbt_compound := '{' (named_tag (',' named_tag)*)? '}' ;
     named_tag := [^:]* ':' nbt_tag ;

     nbt_list := '[' (nbt_tag (',' nbt_tag)*)? ']' ;

     nbt_primitive := nbt_double | nbt_float | nbt_byte | nbt_long |
                      nbt_short | nbt_int | nbt_string | nbt_int_array ;
     nbt_double := float ('d' | 'D')? ;
     nbt_float := float ('f' | 'F') ;
     nbt_byte := int ('b' | 'B') | 'true' | 'false' ;
     nbt_long := int ('l' | 'L') ;
     nbt_short := int ('s' | 'S') ;
     nbt_int :=  int ;
     nbt_string := '"' ([^"] | '\"' | '\\')* '"' ;
     nbt_int_array := '[' (int (',' int)*)? ']' ;

     digit := [0-9] ;
     float := [-+]? digit* '.'? digit+ ;
     int := [-+]? digit+ ;
 
```
    Parameters:
    
    serialized - the string representation of the compound tag
    
    Returns:
    
    the compound tag represented by the serialized representation
    
    Throws:
    
    NBTException - if the string cannot be parsed. The cause of the exception is the underlying parse exception.
  - newByteTag
```
public abstract NBTBaseTag<java.lang.Byte> newByteTag(byte value)
```
    Wrap the value in a byte tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new byte tag with the given value
  - newShortTag
```
public abstract NBTBaseTag<java.lang.Short> newShortTag(short value)
```
    Wrap the value in a short tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new short tag with the given value
  - newIntTag
```
public abstract NBTBaseTag<java.lang.Integer> newIntTag(int value)
```
    Wrap the value in a int tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new int tag with the given value
  - newLongTag
```
public abstract NBTBaseTag<java.lang.Long> newLongTag(long value)
```
    Wrap the value in a long tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new long tag with the given value
  - newFloatTag
```
public abstract NBTBaseTag<java.lang.Float> newFloatTag(float value)
```
    Wrap the value in a float tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new float tag with the given value
  - newDoubleTag
```
public abstract NBTBaseTag<java.lang.Double> newDoubleTag(double value)
```
    Wrap the value in a double tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new double tag with the given value
  - newByteArrayTag
```
public abstract NBTBaseTag<byte[]> newByteArrayTag(byte[] value)
```
    Wrap the value in a byte[] tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new byte[] tag with the given value
  - newStringTag
```
public abstract NBTBaseTag<java.lang.String> newStringTag(java.lang.String value)
```
    Wrap the value in a String tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new String tag with the given value
  - newListTag
```
public abstract NBTListTag newListTag()
```
    Create an empty list tag.
    
    Returns:
    
    the newly created list tag.
  - newCompoundTag
```
public abstract NBTCompoundTag newCompoundTag()
```
    Create an empty compound tag.
    
    Returns:
    
    the newly created compound tag.
  - newIntArrayTag
```
public abstract NBTBaseTag<int[]> newIntArrayTag(int[] value)
```
    Wrap the value in a int[] tag.
    
    Parameters:
    
    value - the value to wrap
    
    Returns:
    
    a new int[] tag with the given value

Class TagFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TagFactory

Method Detail

get

getItemIODelegate

getEntityIODelegate

getBlockIODelegate

getFileIODelegate

parse

newByteTag

newShortTag

newIntTag

newLongTag

newFloatTag

newDoubleTag

newByteArrayTag

newStringTag

newListTag

newCompoundTag

newIntArrayTag