NBTList (PowerNBT 0.8.7 API)

java.lang.Object
- me.dpohvar.powernbt.api.NBTList

All Implemented Interfaces:

Iterable<Object>, Collection<Object>, List<Object>

Direct Known Subclasses:

NBTList.NBTSubList
```
public class NBTList
extends Object
implements List<Object>
```
Represent net.minecraft.server.NBTTagList.
Allows you to work with NBTTagList as with List.
values on get() will be converted to java primitive types if it possible.
net.minecraft.server.NBTTagList converted to NBTList
net.minecraft.server.NBTTagCompound converted to NBTCompound
types allowed to set to empty NBTList:
* all primitive types (boolean as NBTTagByte 0 or 1)
* Object[] as NBTTagList
* java.util.Collection as NBTTagList
* java.util.Map as NBTTagCompound
arrays, collections and maps must contains only the allowed values.
You can add any allowed value to empty NBTList
if NBTList is not empty, you can add only values that can be converted to type of NBTList
Example:
```
   NBTList list = new NBTList(); // ok
   list.getType(); // type is 0 - list is empty
   list.add( (int) 15 ); // ok
   list.getType(); // type is 3 - contains integers
   list.add( (float) 3.14 ); // 3.14 converted to 3
   list.add("some text"); // NBTConvertException, can not convert "some text" to int
 
```
Difference from List:
set(int, Object) and add(int, Object) creates clone of NBT tag before set:
```
   NBTList list = new NBTList();
   NBTCompound cmp = new NBTCompound();
   list.add(cmp);
   cmp.put("foo", "bar");
   NBTCompound innerCmp = list.get(0);
   // now innerCmp is empty, because cmp was added to the list before changes.
 
```
NBTList can not contain empty values (null).
NBTList can not contain cross-references.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class NBTList.NBTIterator

class NBTList.NBTSubList

Nested Classes
Modifier and Type	Class and Description
`class`	`NBTList.NBTIterator`
`class`	`NBTList.NBTSubList`

Constructor Summary

Constructors
Constructor and Description
`NBTList()` Create a new empty NBTList
`NBTList(Collection collection)` Convert java `Collection` to NBTList.
`NBTList(Object[] array)` Convert java array to NBTList

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, Object element)`
`boolean`	`add(Object o)` Appends `clone` of the value to the end of NBTList
`boolean`	`addAll(Collection<?> c)`
`boolean`	`addAll(int index, Collection<?> c)`
`void`	`clear()`
`NBTList`	`clone()` Create clone of this NBT list
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`boolean`	`equals(Object t)`
`static NBTList`	`forNBT(Object tag)` Create a new instance of NBTList by NBTTagList.
`static NBTList`	`forNBTCopy(Object tag)` Create a new instance of NBTList by copy of NBTTagList.
`Object`	`get(int index)`
`Object`	`getHandle()` Get original NBTTagList.
`Object`	`getHandleCopy()` Get copy of original NBTTagList.
`List<Object>`	`getHandleList()` Get list stored in original NBTTagList.
`byte`	`getType()` Get byte type of original NBTTagList.
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`NBTList.NBTIterator`	`iterator()`
`int`	`lastIndexOf(Object o)`
`NBTList.NBTIterator`	`listIterator()`
`NBTList.NBTIterator`	`listIterator(int index)`
`Object`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`Object`	`set(int index, Object element)`
`int`	`size()`
`NBTList.NBTSubList`	`subList(int fromIndex, int toIndex)`
`Object[]`	`toArray()`
`<T> T[]`	`toArray(T[] a)`
`ArrayList<Object>`	`toArrayList()` Convert nbt list to `ArrayList`
`<T extends Collection<Object>> T`	`toCollection(T collection)` Convert NBTList to java `Collection`
`<T extends List<Object>> T`	`toList(T list)` Convert NBTList to java `List`
`String`	`toString()`

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

Methods inherited from interface java.util.List
hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Constructor Detail
  - NBTList
```
public NBTList(Collection collection)
```
    Convert java Collection to NBTList.
    Map should not contain cross-references!
    
    Parameters:
    
    collection - collection
  - NBTList
```
public NBTList(Object[] array)
```
    Convert java array to NBTList
    
    Parameters:
    
    array - array
  - NBTList
```
public NBTList()
```
    Create a new empty NBTList
- Method Detail
  - forNBT
```
public static NBTList forNBT(Object tag)
```
    Create a new instance of NBTList by NBTTagList.
    all changes of created list will affect to NBTTagList.
    
    Parameters:
    
    tag - instance of net.minecraft.server.NBTTagCompound
    
    Returns:
    
    NBTList
  - forNBTCopy
```
public static NBTList forNBTCopy(Object tag)
```
    Create a new instance of NBTList by copy of NBTTagList.
    
    Parameters:
    
    tag - instance of net.minecraft.server.NBTTagCompound
    
    Returns:
    
    NBTList
  - equals
```
public boolean equals(Object t)
```
    Specified by:
    
    equals in interface Collection<Object>
    
    Specified by:
    
    equals in interface List<Object>
    
    Overrides:
    
    equals in class Object
  - getHandleList
```
public List<Object> getHandleList()
```
    Get list stored in original NBTTagList.
    
    Returns:
    
    handle list
  - getHandle
```
public Object getHandle()
```
    Get original NBTTagList.
    
    Returns:
    
    NBTTagList
  - getHandleCopy
```
public Object getHandleCopy()
```
    Get copy of original NBTTagList.
    
    Returns:
    
    NBTTagList
  - getType
```
public byte getType()
```
    Get byte type of original NBTTagList.
    
    Returns:
    
    type of list or 0 if list is empty
  - toList
```
public <T extends List<Object>> T toList(T list)
```
    Convert NBTList to java List
    
    Type Parameters:
    
    T - T
    
    Parameters:
    
    list - empty list to fill
    
    Returns:
    
    list
  - toCollection
```
public <T extends Collection<Object>> T toCollection(T collection)
```
    Convert NBTList to java Collection
    
    Type Parameters:
    
    T - T
    
    Parameters:
    
    collection - empty collection to fill
    
    Returns:
    
    collection
  - toArrayList
```
public ArrayList<Object> toArrayList()
```
    Convert nbt list to ArrayList
    
    Returns:
    
    ArrayList
  - clone
```
public NBTList clone()
```
    Create clone of this NBT list
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    cloned NBTList
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<Object>
    
    Specified by:
    
    size in interface List<Object>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<Object>
    
    Specified by:
    
    isEmpty in interface List<Object>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<Object>
    
    Specified by:
    
    contains in interface List<Object>
  - iterator
```
public NBTList.NBTIterator iterator()
```
    Specified by:
    
    iterator in interface Iterable<Object>
    
    Specified by:
    
    iterator in interface Collection<Object>
    
    Specified by:
    
    iterator in interface List<Object>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
  - toArray
```
public <T> T[] toArray(T[] a)
```
    Specified by:
    
    toArray in interface Collection<Object>
    
    Specified by:
    
    toArray in interface List<Object>
  - add
```
public boolean add(Object o)
```
    Appends clone of the value to the end of NBTList
    
    Specified by:
    
    add in interface Collection<Object>
    
    Specified by:
    
    add in interface List<Object>
    
    Parameters:
    
    o - value to be appended to NBTList
    
    Returns:
    
    true if NBTList is changed
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<Object>
    
    Specified by:
    
    remove in interface List<Object>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<Object>
    
    Specified by:
    
    containsAll in interface List<Object>
  - addAll
```
public boolean addAll(Collection<?> c)
```
    Specified by:
    
    addAll in interface Collection<Object>
    
    Specified by:
    
    addAll in interface List<Object>
  - addAll
```
public boolean addAll(int index,
                      Collection<?> c)
```
    Specified by:
    
    addAll in interface List<Object>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<Object>
    
    Specified by:
    
    removeAll in interface List<Object>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<Object>
    
    Specified by:
    
    retainAll in interface List<Object>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<Object>
    
    Specified by:
    
    clear in interface List<Object>
  - get
```
public Object get(int index)
```
    Specified by:
    
    get in interface List<Object>
  - set
```
public Object set(int index,
                  Object element)
```
    Specified by:
    
    set in interface List<Object>
  - add
```
public void add(int index,
                Object element)
```
    Specified by:
    
    add in interface List<Object>
  - remove
```
public Object remove(int index)
```
    Specified by:
    
    remove in interface List<Object>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<Object>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<Object>
  - listIterator
```
public NBTList.NBTIterator listIterator()
```
    Specified by:
    
    listIterator in interface List<Object>
  - listIterator
```
public NBTList.NBTIterator listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<Object>
  - subList
```
public NBTList.NBTSubList subList(int fromIndex,
                                  int toIndex)
```
    Specified by:
    
    subList in interface List<Object>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NBTList

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Constructor Detail

NBTList

NBTList

NBTList

Method Detail

forNBT

forNBTCopy

equals

getHandleList

getHandle

getHandleCopy

getType

toList

toCollection

toArrayList

clone

size

isEmpty

contains

iterator

toArray

toArray

add

remove

containsAll

addAll

addAll

removeAll

retainAll

clear

get

set

add

remove

indexOf

lastIndexOf

listIterator

listIterator

subList

toString