com.asakusafw.runtime.flow

Class FileMapListBuffer<E extends org.apache.hadoop.io.Writable>

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

com.asakusafw.runtime.flow.FileMapListBuffer<E>

Type Parameters:

E - the element type

All Implemented Interfaces:

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

public class FileMapListBuffer<E extends org.apache.hadoop.io.Writable>
extends AbstractList<E>
implements ListBuffer<E>

An implementation of ListBuffer which may spill contents into backing temporary files.

Since:

0.1.0

Version:

0.9.1

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
FileMapListBuffer() Creates a new instance.
FileMapListBuffer(int cacheSize) Creates a new instance.
FileMapListBuffer(int cacheSize, int bufferSoftLimit) Creates a new instance.

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.
E	get(int index)
boolean	isExpandRequired() Returns whether a new element object is required for the buffer or not.
void	shrink() Shrinks this buffer.
int	size()

Methods inherited from class java.util.AbstractList

add, add, addAll, clear, equals, hashCode, indexOf, iterator, lastIndexOf, listIterator, listIterator, remove, removeRange, set, 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

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

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

FileMapListBuffer

public FileMapListBuffer()

Creates a new instance.

FileMapListBuffer

public FileMapListBuffer(int cacheSize)

Creates a new instance.

Parameters:

cacheSize - the number of objects should be cached on Java heap

FileMapListBuffer

public FileMapListBuffer(int cacheSize,
                         int bufferSoftLimit)

Creates a new instance.

Parameters:

cacheSize - the number of objects should be cached on Java heap

bufferSoftLimit - the buffer size soft limit in bytes

Since:

0.9.1

Method Detail

begin

public void begin()

Description copied from interface: ListBuffer

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 ListBuffer.advance(). After changing the buffer, then clients must invoke ListBuffer.end() and the buffer can be used as the unmodifiable list.

Specified by:

begin in interface ListBuffer<E extends org.apache.hadoop.io.Writable>

See Also:

ListBuffer.advance()

end

public void end()

Description copied from interface: ListBuffer

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

Specified by:

end in interface ListBuffer<E extends org.apache.hadoop.io.Writable>

isExpandRequired

public boolean isExpandRequired()

Description copied from interface: ListBuffer

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

Specified by:

isExpandRequired in interface ListBuffer<E extends org.apache.hadoop.io.Writable>

Returns:

true if a new element object is required, otherwise false

See Also:

ListBuffer.expand(Object)

expand

public void expand(E value)

Description copied from interface: ListBuffer

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

Specified by:

expand in interface ListBuffer<E extends org.apache.hadoop.io.Writable>

Parameters:

value - the object

See Also:

ListBuffer.isExpandRequired(), ListBuffer.isExpandRequired()

advance

public E advance()

Description copied from interface: ListBuffer

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

Specified by:

advance in interface ListBuffer<E extends org.apache.hadoop.io.Writable>

Returns:

the next element object

See Also:

ListBuffer.isExpandRequired(), ListBuffer.expand(Object)

get

public E get(int index)

Specified by:

get in interface List<E extends org.apache.hadoop.io.Writable>

Specified by:

get in class AbstractList<E extends org.apache.hadoop.io.Writable>

size

public int size()

Specified by:

size in interface Collection<E extends org.apache.hadoop.io.Writable>

Specified by:

size in interface List<E extends org.apache.hadoop.io.Writable>

Specified by:

size in class AbstractCollection<E extends org.apache.hadoop.io.Writable>

shrink

public void shrink()

Description copied from interface: ListBuffer

Shrinks this buffer.

Specified by:

shrink in interface ListBuffer<E extends org.apache.hadoop.io.Writable>