com.asakusafw.runtime.flow

Interface ListBuffer<E>

Type Parameters:

E - the element type

All Superinterfaces:

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

All Known Implementing Classes:

ArrayListBuffer, FileMapListBuffer

public interface ListBuffer<E>
extends List<E>

A List interface for reusing instances of element objects.

Iterator<Hoge> iter = ...;
ListBuffer<Hoge> hoges = ...;
...

hoges.begin();
while (iter.hasNext()) {
    Hoge hoge = iter.next();
    if (hoges.isExpandRequired()) {
        hoges.expand(new Hoge());
    }
    hoges.advance().set(hoge);
}
hoges.end();

// use hoges as List

hoges.shrink();

Method Summary

Modifier and Type	Method and Description
E	advance() Returns the next element object on the internal cursor, and then move the cursor to the next element.
void	begin() Begins changing the list buffer.
void	end() Ends changing the list buffer.
void	expand(E value) Adds a new element object into the tail of this buffer.
boolean	isExpandRequired() Returns whether a new element object is required for the buffer or not.
void	shrink() Shrinks this buffer.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

begin

void begin()

Begins changing the list buffer. Initially, the internal cursor is on the head of this buffer, and clients can move it to the next element by invoking advance(). After changing the buffer, then clients must invoke end() and the buffer can be used as the unmodifiable list.

Throws:

BufferException - if failed to prepare buffer

See Also:

advance()

end

void end()

Ends changing the list buffer. After this, clients should not change the buffer contents. If clients want to change the buffer, must invoke begin() once more.

Throws:

BufferException - if failed to prepare buffer

isExpandRequired

boolean isExpandRequired()

Returns whether a new element object is required for the buffer or not. If it required, clients must use expand(Object) to add a new object before invoke advance(). This method must be invoked between begin() and end().

Returns:

true if a new element object is required, otherwise false

Throws:

BufferException - if failed to prepare buffer

See Also:

expand(Object)

expand

void expand(E value)

Adds a new element object into the tail of this buffer. This method must be invoked between begin() and end().

Parameters:

value - the object

Throws:

IndexOutOfBoundsException - if expand is not required (optional operation)

BufferException - if failed to prepare buffer

See Also:

isExpandRequired(), isExpandRequired()

advance

E advance()

Returns the next element object on the internal cursor, and then move the cursor to the next element. This method must be invoked between begin() and end().

Returns:

the next element object

Throws:

IndexOutOfBoundsException - if the next element object is not prepared

BufferException - if failed to prepare buffer

See Also:

isExpandRequired(), expand(Object)

shrink

void shrink()

Shrinks this buffer.