Tag (jo-nbt 1.3.0 API)

java.lang.Object
- se.llbit.nbt.Tag

Direct Known Subclasses:

NamedTag, SpecificTag
```
public abstract class Tag
extends java.lang.Object
```
Abstract base class for all kinds of NBT tags.
NBT is a tree structure. Compound and List tags are internal nodes in the tree, while other tag types are leafs.

Field Summary

Fields
Modifier and Type	Field and Description
`static SpecificTag`	`END`
`static int`	`TAG_BYTE`
`static int`	`TAG_BYTE_ARRAY`
`static int`	`TAG_COMPOUND`
`static int`	`TAG_DOUBLE`
`static int`	`TAG_END`
`static int`	`TAG_FLOAT`
`static int`	`TAG_INT`
`static int`	`TAG_INT_ARRAY`
`static int`	`TAG_LIST`
`static int`	`TAG_LONG`
`static int`	`TAG_LONG_ARRAY`
`static int`	`TAG_SHORT`
`static int`	`TAG_STRING`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Tag()

Constructors
Modifier	Constructor and Description
`protected`	`Tag()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`CompoundTag`	`asCompound()` Returns this tag if it is a list tag, otherwise an empty list.
`ListTag`	`asList()` Returns this tag if it is a list tag, otherwise an empty list.
`boolean`	`boolValue()`
`boolean`	`boolValue(boolean defaultValue)`
`byte[]`	`byteArray()`
`byte[]`	`byteArray(byte[] defaultValue)`
`int`	`byteValue()`
`int`	`byteValue(int defaultValue)`
`double`	`doubleValue()`
`double`	`doubleValue(double defaultValue)`
`java.lang.String`	`dumpTree()` Builds a string representation of this NBT tag and its children.
`java.lang.String`	`error()` Gives the error message for an error tag.
`java.lang.String`	`extraInfo()` Extra information for this tag, printed in the tree dump.
`float`	`floatValue()`
`float`	`floatValue(float defaultValue)`
`Tag`	`get(int i)`
`Tag`	`get(java.lang.String name)`
`int[]`	`intArray()`
`int[]`	`intArray(int[] defaultValue)`
`int`	`intValue()`
`int`	`intValue(int defaultValue)`
`boolean`	`isByteArray(int size)` Test if this is an int array with a size greater or equal to the given size.
`boolean`	`isCompoundTag()`
`boolean`	`isEnd()`
`boolean`	`isError()`
`boolean`	`isIntArray(int size)` Test if this is an int array with a size greater or equal to the given size.
`boolean`	`isList()`
`boolean`	`isLongArray(int size)` Test if this is a long array with a size greater or equal to the given size.
`boolean`	`isNamed(java.lang.String name)` Test if this is a named tag with the given name.
`long[]`	`longArray()`
`long[]`	`longArray(long[] defaultValue)`
`long`	`longValue()`
`long`	`longValue(long defaultValue)`
`void`	`printTag(java.lang.StringBuilder buff, java.lang.String indent)` Print a string representation of this tag to the argument buffer.
`void`	`printTagInfo(java.lang.StringBuilder buff)` Print a string representation of this tag to the argument buffer.
`boolean`	`same(java.lang.String name)` Test if this is a string tag that contains the given string.
`void`	`set(int i, SpecificTag tag)`
`void`	`set(java.lang.String name, Tag tag)`
`short`	`shortValue()`
`short`	`shortValue(short defaultValue)`
`java.lang.String`	`stringValue()`
`java.lang.String`	`stringValue(java.lang.String defaultValue)`
`abstract java.lang.String`	`tagName()`
`java.lang.String`	`toString()`
`Tag`	`unpack()` Unwraps a named tag.
`abstract void`	`write(java.io.DataOutputStream out)`

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

Field Detail
- TAG_END
```
public static final int TAG_END
```
  See Also:
  
  Constant Field Values
- TAG_BYTE
```
public static final int TAG_BYTE
```
  See Also:
  
  Constant Field Values
- TAG_SHORT
```
public static final int TAG_SHORT
```
  See Also:
  
  Constant Field Values
- TAG_INT
```
public static final int TAG_INT
```
  See Also:
  
  Constant Field Values
- TAG_LONG
```
public static final int TAG_LONG
```
  See Also:
  
  Constant Field Values
- TAG_FLOAT
```
public static final int TAG_FLOAT
```
  See Also:
  
  Constant Field Values
- TAG_DOUBLE
```
public static final int TAG_DOUBLE
```
  See Also:
  
  Constant Field Values
- TAG_BYTE_ARRAY
```
public static final int TAG_BYTE_ARRAY
```
  See Also:
  
  Constant Field Values
- TAG_STRING
```
public static final int TAG_STRING
```
  See Also:
  
  Constant Field Values
- TAG_LIST
```
public static final int TAG_LIST
```
  See Also:
  
  Constant Field Values
- TAG_COMPOUND
```
public static final int TAG_COMPOUND
```
  See Also:
  
  Constant Field Values
- TAG_INT_ARRAY
```
public static final int TAG_INT_ARRAY
```
  See Also:
  
  Constant Field Values
- TAG_LONG_ARRAY
```
public static final int TAG_LONG_ARRAY
```
  See Also:
  
  Constant Field Values
- END
```
public static final SpecificTag END
```

Constructor Detail
- Tag
```
protected Tag()
```

Method Detail

tagName

public abstract java.lang.String tagName()

isError
```
public boolean isError()
```

isNamed
```
public boolean isNamed(java.lang.String name)
```
Test if this is a named tag with the given name.

Returns:

true if this is a named tag with the given name.

same
```
public boolean same(java.lang.String name)
```
Test if this is a string tag that contains the given string.

dumpTree
```
public java.lang.String dumpTree()
```
Builds a string representation of this NBT tag and its children.

printTagInfo
```
public void printTagInfo(java.lang.StringBuilder buff)
```
Print a string representation of this tag to the argument buffer.

printTag

public void printTag(java.lang.StringBuilder buff,
                     java.lang.String indent)

Print a string representation of this tag to the argument buffer.

extraInfo
```
public java.lang.String extraInfo()
```
Extra information for this tag, printed in the tree dump.

write

public abstract void write(java.io.DataOutputStream out)
                    throws java.io.IOException

Throws:: java.io.IOException

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

isEnd
```
public boolean isEnd()
```

unpack
```
public Tag unpack()
```
Unwraps a named tag.

Returns:

the content of a named tag, or this same tag if it is not a named tag.

error
```
public java.lang.String error()
```
Gives the error message for an error tag.

boolValue
```
public boolean boolValue()
```

boolValue

public boolean boolValue(boolean defaultValue)

byteValue
```
public int byteValue()
```

byteValue

public int byteValue(int defaultValue)

shortValue
```
public short shortValue()
```

shortValue

public short shortValue(short defaultValue)

intValue
```
public int intValue()
```

intValue

public int intValue(int defaultValue)

longValue
```
public long longValue()
```

longValue

public long longValue(long defaultValue)

floatValue
```
public float floatValue()
```

floatValue

public float floatValue(float defaultValue)

doubleValue
```
public double doubleValue()
```

doubleValue

public double doubleValue(double defaultValue)

stringValue
```
public java.lang.String stringValue()
```

stringValue

public java.lang.String stringValue(java.lang.String defaultValue)

byteArray
```
public byte[] byteArray()
```

byteArray

public byte[] byteArray(byte[] defaultValue)

intArray
```
public int[] intArray()
```

intArray

public int[] intArray(int[] defaultValue)

longArray
```
public long[] longArray()
```

longArray

public long[] longArray(long[] defaultValue)

isCompoundTag
```
public boolean isCompoundTag()
```

isList
```
public boolean isList()
```

isByteArray
```
public boolean isByteArray(int size)
```
Test if this is an int array with a size greater or equal to the given size.

isIntArray
```
public boolean isIntArray(int size)
```
Test if this is an int array with a size greater or equal to the given size.

isLongArray
```
public boolean isLongArray(int size)
```
Test if this is a long array with a size greater or equal to the given size.

get

public Tag get(java.lang.String name)

set

public void set(java.lang.String name,
                Tag tag)

set

public void set(int i,
                SpecificTag tag)

get
```
public Tag get(int i)
```

asList
```
public ListTag asList()
```
Returns this tag if it is a list tag, otherwise an empty list.

asCompound
```
public CompoundTag asCompound()
```
Returns this tag if it is a list tag, otherwise an empty list.

Class Tag

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAG_END

TAG_BYTE

TAG_SHORT

TAG_INT

TAG_LONG

TAG_FLOAT

TAG_DOUBLE

TAG_BYTE_ARRAY

TAG_STRING

TAG_LIST

TAG_COMPOUND

TAG_INT_ARRAY

TAG_LONG_ARRAY

END

Constructor Detail

Tag

Method Detail

tagName

isError

isNamed

same

dumpTree

printTagInfo

printTag

extraInfo

write

toString

isEnd

unpack

error

boolValue

boolValue

byteValue

byteValue

shortValue

shortValue

intValue

intValue

longValue

longValue

floatValue

floatValue

doubleValue

doubleValue

stringValue

stringValue

byteArray

byteArray

intArray

intArray

longArray

longArray

isCompoundTag

isList

isByteArray

isIntArray

isLongArray

get

set

set

get

asList

asCompound