de.tr7zw.changeme.nbtapi

Class NBTList<T>

java.lang.Object

de.tr7zw.changeme.nbtapi.NBTList<T>

Type Parameters:

T -

All Implemented Interfaces:

ReadableNBTList<T>, ReadWriteNBTList<T>, Iterable<T>, Collection<T>, List<T>

Direct Known Subclasses:

NBTCompoundList, NBTDoubleList, NBTFloatList, NBTIntArrayList, NBTIntegerList, NBTLongList, NBTStringList, NBTUUIDList

public abstract class NBTList<T>
extends Object
implements List<T>, ReadWriteNBTList<T>

Abstract List implementation for ListCompounds

Author:

tr7zw

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	listObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NBTList(NBTCompound owner, String name, NBTType type, Object list)

Method Summary

Modifier and Type	Method and Description
void	add(int index, T element) Adds the specified element at the specified position in this list.
boolean	add(T element) Adds the specified element to this set if it is not already present.
boolean	addAll(Collection<? extends T> c) Adds all of the elements in the specified collection to this collection.
boolean	addAll(int index, Collection<? extends T> c) Inserts all of the elements in the specified collection into this list, starting at the specified position.
protected abstract Object	asTag(T object)
void	clear() Clears the contents of the list
boolean	contains(Object o) Returns true if this list contains the specified element.
boolean	containsAll(Collection<?> c) Returns true if this collection contains all of the elements in the specified collection
String	getName()
NBTCompound	getParent()
NBTType	getType() Returns the type of this tag
int	indexOf(Object o) Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.
boolean	isEmpty() Returns true if the list is empty, false otherwise.
Iterator<T>	iterator()
int	lastIndexOf(Object o) Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element
ListIterator<T>	listIterator()
ListIterator<T>	listIterator(int startIndex) Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list
T	remove(int i) Remove the element at index i and return it.
boolean	remove(Object o) Removes the first occurrence of the specified element from this list, if it is present.
boolean	removeAll(Collection<?> c) Removes from this collection all of its elements that are contained in the specified collection
boolean	removeIf(Predicate<? super T> filter) "Remove all elements from the list that match the given predicate."
boolean	retainAll(Collection<?> c) Removes all of this collection's elements that are not contained in the specified collection.
protected void	save()
T	set(int index, T element) Replaces the element at the specified position in this list with the specified element.
int	size() Returns the number of elements in this list.
List<T>	subList(int fromIndex, int toIndex) Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive
Object[]	toArray() Returns an array containing all of the elements in this list in proper sequence (from first to last element).
<E> E[]	toArray(E[] a) Returns an array containing all of the elements in this list in proper sequence (from first to last element).
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, get, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, stream

Methods inherited from interface de.tr7zw.changeme.nbtapi.iface.ReadableNBTList

get, toListCopy

Methods inherited from interface java.lang.Iterable

forEach

Field Detail

listObject

protected Object listObject

Constructor Detail

NBTList

protected NBTList(NBTCompound owner,
                  String name,
                  NBTType type,
                  Object list)

Method Detail

getName

public String getName()

Returns:

Name of this list-compound

getParent

public NBTCompound getParent()

Returns:

The Compound's parent Object

save

protected void save()

asTag

protected abstract Object asTag(T object)

add

public boolean add(T element)

Description copied from interface: ReadWriteNBTList

Adds the specified element to this set if it is not already present.

Specified by:

add in interface ReadWriteNBTList<T>

Specified by:

add in interface Collection<T>

Specified by:

add in interface List<T>

Parameters:

element - The element to be added to the list.

Returns:

A boolean value.

add

public void add(int index,
                T element)

Description copied from interface: ReadWriteNBTList

Adds the specified element at the specified position in this list.

Specified by:

add in interface ReadWriteNBTList<T>

Specified by:

add in interface List<T>

Parameters:

index - The index at which the specified element is to be inserted

element - The element to be added to the list.

set

public T set(int index,
             T element)

Description copied from interface: ReadWriteNBTList

Replaces the element at the specified position in this list with the specified element.

Specified by:

set in interface ReadWriteNBTList<T>

Specified by:

set in interface List<T>

Parameters:

index - The index of the element to replace

element - The element to be stored at the specified position

Returns:

The element that was previously at the specified position.

remove

public T remove(int i)

Description copied from interface: ReadWriteNBTList

Remove the element at index i and return it.

Specified by:

remove in interface ReadWriteNBTList<T>

Specified by:

remove in interface List<T>

Parameters:

i - the index of the element to be removed

Returns:

The element that was removed.

size

public int size()

Description copied from interface: ReadableNBTList

Returns the number of elements in this list.

Specified by:

size in interface ReadableNBTList<T>

Specified by:

size in interface Collection<T>

Specified by:

size in interface List<T>

Returns:

The size of the list.

getType

public NBTType getType()

Description copied from interface: ReadableNBTList

Returns the type of this tag

Specified by:

getType in interface ReadableNBTList<T>

Returns:

The type that this list contains

isEmpty

public boolean isEmpty()

Description copied from interface: ReadableNBTList

Returns true if the list is empty, false otherwise.

Specified by:

isEmpty in interface ReadableNBTList<T>

Specified by:

isEmpty in interface Collection<T>

Specified by:

isEmpty in interface List<T>

Returns:

A boolean value.

clear

public void clear()

Description copied from interface: ReadWriteNBTList

Clears the contents of the list

Specified by:

clear in interface ReadWriteNBTList<T>

Specified by:

clear in interface Collection<T>

Specified by:

clear in interface List<T>

contains

public boolean contains(Object o)

Description copied from interface: ReadableNBTList

Returns true if this list contains the specified element.

Specified by:

contains in interface ReadableNBTList<T>

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface List<T>

Parameters:

o - The object to be searched for in the list.

Returns:

A boolean value.

indexOf

public int indexOf(Object o)

Description copied from interface: ReadableNBTList

Returns the index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

Specified by:

indexOf in interface ReadableNBTList<T>

Specified by:

indexOf in interface List<T>

Parameters:

o - The object to search for.

Returns:

The index of the first occurrence of the specified element in this list, or -1 if this list does not contain the element.

addAll

public boolean addAll(Collection<? extends T> c)

Description copied from interface: ReadWriteNBTList

Adds all of the elements in the specified collection to this collection.

Specified by:

addAll in interface ReadWriteNBTList<T>

Specified by:

addAll in interface Collection<T>

Specified by:

addAll in interface List<T>

Parameters:

c - The collection to be added to the list.

Returns:

A boolean value.

addAll

public boolean addAll(int index,
                      Collection<? extends T> c)

Description copied from interface: ReadWriteNBTList

Inserts all of the elements in the specified collection into this list, starting at the specified position.

Specified by:

addAll in interface ReadWriteNBTList<T>

Specified by:

addAll in interface List<T>

Parameters:

index - The index at which the elements of the specified collection are to be inserted.

c - The collection to be added to the list.

Returns:

A boolean value.

containsAll

public boolean containsAll(Collection<?> c)

Description copied from interface: ReadableNBTList

Returns true if this collection contains all of the elements in the specified collection

Specified by:

containsAll in interface ReadableNBTList<T>

Specified by:

containsAll in interface Collection<T>

Specified by:

containsAll in interface List<T>

Parameters:

c - The collection to be checked for containment in this list

Returns:

A boolean value.

lastIndexOf

public int lastIndexOf(Object o)

Description copied from interface: ReadableNBTList

Returns the index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element

Specified by:

lastIndexOf in interface ReadableNBTList<T>

Specified by:

lastIndexOf in interface List<T>

Parameters:

o - The object to search for.

Returns:

The index of the last occurrence of the specified element in this list, or -1 if this list does not contain the element.

removeAll

public boolean removeAll(Collection<?> c)

Description copied from interface: ReadWriteNBTList

Removes from this collection all of its elements that are contained in the specified collection

Specified by:

removeAll in interface ReadWriteNBTList<T>

Specified by:

removeAll in interface Collection<T>

Specified by:

removeAll in interface List<T>

Parameters:

c - The collection to be removed from this list.

Returns:

A boolean value.

retainAll

public boolean retainAll(Collection<?> c)

Description copied from interface: ReadWriteNBTList

Removes all of this collection's elements that are not contained in the specified collection.

Specified by:

retainAll in interface ReadWriteNBTList<T>

Specified by:

retainAll in interface Collection<T>

Specified by:

retainAll in interface List<T>

Parameters:

c - The collection to be retained in this list

Returns:

A boolean value.

remove

public boolean remove(Object o)

Description copied from interface: ReadWriteNBTList

Removes the first occurrence of the specified element from this list, if it is present.

Specified by:

remove in interface ReadWriteNBTList<T>

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface List<T>

Parameters:

o - The object to be removed from the list.

Returns:

A boolean value.

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

Specified by:

iterator in interface List<T>

listIterator

public ListIterator<T> listIterator()

Specified by:

listIterator in interface List<T>

listIterator

public ListIterator<T> listIterator(int startIndex)

Description copied from interface: ReadWriteNBTList

Returns a list iterator over the elements in this list (in proper sequence), starting at the specified position in the list

Specified by:

listIterator in interface ReadWriteNBTList<T>

Specified by:

listIterator in interface List<T>

Parameters:

startIndex - The index of the first element to be returned from the list iterator (by a call to the next method).

Returns:

A list iterator of the list starting at the specified index.

toArray

public Object[] toArray()

Description copied from interface: ReadableNBTList

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

Specified by:

toArray in interface ReadableNBTList<T>

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Returns:

An array of objects.

toArray

public <E> E[] toArray(E[] a)

Description copied from interface: ReadableNBTList

Returns an array containing all of the elements in this list in proper sequence (from first to last element).

Specified by:

toArray in interface ReadableNBTList<T>

Specified by:

toArray in interface Collection<T>

Specified by:

toArray in interface List<T>

Parameters:

a - The array into which the elements of the list are to be stored, if it is big enough; otherwise, a new array of the same runtime type is allocated for this purpose.

Returns:

An array of the elements in the list.

subList

public List<T> subList(int fromIndex,
                       int toIndex)

Description copied from interface: ReadableNBTList

Returns a view of the portion of this list between the specified fromIndex, inclusive, and toIndex, exclusive

Specified by:

subList in interface ReadableNBTList<T>

Specified by:

subList in interface List<T>

Parameters:

fromIndex - The starting index of the sublist (inclusive).

toIndex - The index of the last element in the sublist.

Returns:

A view of the specified range within this list.

removeIf

public boolean removeIf(Predicate<? super T> filter)

Description copied from interface: ReadWriteNBTList

"Remove all elements from the list that match the given predicate." The Predicate interface is a functional interface that takes a single argument and returns a boolean

Specified by:

removeIf in interface ReadWriteNBTList<T>

Specified by:

removeIf in interface Collection<T>

Parameters:

filter - The predicate to apply to each element to determine if it should be removed.

Returns:

A boolean value.

toString

public String toString()

Overrides:

toString in class Object