ml.shifu.guagua.util

Class MemoryLimitedList<T>

java.lang.Object

ml.shifu.guagua.util.MemoryLimitedList<T>

All Implemented Interfaces:

Iterable<T>, AppendList<T>

public class MemoryLimitedList<T>
extends Object
implements AppendList<T>

A simple wrapper list with limited byte size.

Only two stages support in such kind of list. The first one is WRITE, the next is read. So far random WRITE and READ are not supported in this list.

If current size is over limited size, a GuaguaRuntimeException is added when #add(Object).

Author:

Zhang David (pengzhang@paypal.com)

Nested Class Summary

Nested classes/interfaces inherited from interface ml.shifu.guagua.util.AppendList

AppendList.State

Constructor Summary

Constructors

Constructor and Description
MemoryLimitedList(List<T> delegationList) Constructor with delegation list
MemoryLimitedList(long maxSize, List<T> delegationList) Constructor with max bytes size limit and delegation list.

Method Summary

Modifier and Type	Method and Description
boolean	append(T t) Append object to this list
void	clear() Clear all elements.
T	get(int index) Retrieve record given index.
Iterator<T>	iterator()
int	size() Return size of this list.
void	switchState() After appending, switch state from WRITE to READ to allow iterating.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

MemoryLimitedList

public MemoryLimitedList(long maxSize,
                         List<T> delegationList)

Constructor with max bytes size limit and delegation list.

MemoryLimitedList

public MemoryLimitedList(List<T> delegationList)

Constructor with delegation list

Method Detail

append

public boolean append(T t)

Description copied from interface: AppendList

Append object to this list

Specified by:

append in interface AppendList<T>

Parameters:

t - the object to append

Returns:

whether appending object successful

get

public T get(int index)

Retrieve record given index. This function is only provided in MemoryLimitedList.

Parameters:

index - the index of record to be returned

Returns:

the record in that index

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

switchState

public void switchState()

Description copied from interface: AppendList

After appending, switch state from WRITE to READ to allow iterating.

Specified by:

switchState in interface AppendList<T>

size

public int size()

Description copied from interface: AppendList

Return size of this list.

Specified by:

size in interface AppendList<T>

clear

public void clear()

Description copied from interface: AppendList

Clear all elements.

Specified by:

clear in interface AppendList<T>