com.bergerkiller.bukkit.common.collections

Class InstanceBuffer<E>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.bergerkiller.bukkit.common.collections.InstanceBuffer<E>

Type Parameters:

E - - Instance element type

All Implemented Interfaces:

Iterable<E>, Collection<E>, List<E>

public abstract class InstanceBuffer<E>
extends AbstractList<E>

Keeps instances of elements available even after clearing to avoid the creation of new instances. This can be used to store an infinite or undefined amount of elements. The get and set operations allow operating outside the size of the buffer, and dynamically allocate the new capacity needed.

The createElement() method needs to be implemented to use this buffer.

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
InstanceBuffer()

Method Summary

Modifier and Type	Method and Description
E	add() Gets the next element and increases size by one.
void	add(int index, E element)
List<E>	addAll(int amount) Gets the given amount of next elements and increases the size by the amount
void	clear()
void	clear(boolean clearBuffer) Sets the element count back to 0, optionally clearing the backing buffer
abstract E	createElement() Creates a new Element to use in the buffer
E	get(int index)
E	remove(int index)
E	set(int index, E element)
int	size()

Methods inherited from class java.util.AbstractList

add, addAll, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, removeRange, subList

Methods inherited from class java.util.AbstractCollection

addAll, contains, containsAll, isEmpty, remove, removeAll, retainAll, toArray, toArray, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

addAll, contains, containsAll, isEmpty, remove, removeAll, replaceAll, retainAll, sort, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

InstanceBuffer

public InstanceBuffer()

Method Detail

createElement

public abstract E createElement()

Creates a new Element to use in the buffer

Returns:

new element instance

add

public E add()

Gets the next element and increases size by one.

Returns:

next element added or obtained

addAll

public List<E> addAll(int amount)

Gets the given amount of next elements and increases the size by the amount

Parameters:

amount - to add and get

Returns:

next elements added or obtained

remove

public E remove(int index)

Specified by:

remove in interface List<E>

Overrides:

remove in class AbstractList<E>

get

public E get(int index)

Specified by:

get in interface List<E>

Specified by:

get in class AbstractList<E>

set

public E set(int index,
             E element)

Specified by:

set in interface List<E>

Overrides:

set in class AbstractList<E>

add

public void add(int index,
                E element)

Specified by:

add in interface List<E>

Overrides:

add in class AbstractList<E>

size

public int size()

Specified by:

size in interface Collection<E>

Specified by:

size in interface List<E>

Specified by:

size in class AbstractCollection<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Specified by:

clear in interface List<E>

Overrides:

clear in class AbstractList<E>

clear

public void clear(boolean clearBuffer)

Sets the element count back to 0, optionally clearing the backing buffer

Parameters:

clearBuffer - option: True to clear the backing buffer instances