BytableMemoryDiskList (guagua-core 0.7.8 API)

java.lang.Object
- ml.shifu.guagua.util.BytableMemoryDiskList<T>

All Implemented Interfaces:

Iterable<T>, AppendList<T>
```
public class BytableMemoryDiskList<T extends Bytable>
extends Object
implements AppendList<T>
```
A list to store Bytable data firstly into memory then into disk if over threshold.
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.
WARNING: close() should be called at last to release file descriptor.
User should provide fileName in constructor and only one file is used to store data.

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
`BytableMemoryDiskList(List<T> delegationList, String className)` Constructor with only memory `delegationList`.
`BytableMemoryDiskList(long maxSize, BytableDiskList<T> bytableDiskList)` Constructor with memory bytes size limit and bytableDiskList setting.
`BytableMemoryDiskList(long maxSize, List<T> delegationList, String className)` Constructor with max bytes size of memory and `delegationList`.
`BytableMemoryDiskList(long maxSize, List<T> delegationList, String fileName, String className)` Constructor with max bytes size of memory and `delegationList` and disk file name in current working dir.
`BytableMemoryDiskList(long maxSize, String className)` Constructor with only memory bytes size limit and className.
`BytableMemoryDiskList(long maxSize, String fileName, String className)` Constructor with max bytes size of memory and disk file name in current working dir.
`BytableMemoryDiskList(String className)` Default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`append(T t)` Append object to this list
`void`	`clear()` Clear all elements.
`void`	`close()` Close disk stream.
`long`	`getDiskCount()`
`long`	`getMemoryCount()`
`Iterator<T>`	`iterator()`
`void`	`reOpen()` Reopen stream for iteration.
`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
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(long maxSize,
                             List<T> delegationList,
                             String className)
```
    Constructor with max bytes size of memory and delegationList. Disk file name is random filename in current working dir.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(List<T> delegationList,
                             String className)
```
    Constructor with only memory delegationList. By default no limit of bytes size in memory.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(long maxSize,
                             List<T> delegationList,
                             String fileName,
                             String className)
```
    Constructor with max bytes size of memory and delegationList and disk file name in current working dir.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(long maxSize,
                             String fileName,
                             String className)
```
    Constructor with max bytes size of memory and disk file name in current working dir. By default LinkedList is used for memory list.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(long maxSize,
                             BytableDiskList<T> bytableDiskList)
```
    Constructor with memory bytes size limit and bytableDiskList setting.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(long maxSize,
                             String className)
```
    Constructor with only memory bytes size limit and className.
  - BytableMemoryDiskList
```
public BytableMemoryDiskList(String className)
```
    Default constructor. By default no memory limit, LinkedList and random file name.
- 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 extends Bytable>
    
    Parameters:
    
    t - the object to append
    
    Returns:
    
    whether appending object successful
  - close
```
public void close()
```
    Close disk stream. Should be called at the end of usage of BytableMemoryDiskList.
  - reOpen
```
public void reOpen()
```
    Reopen stream for iteration.
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T extends Bytable>
  - 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 extends Bytable>
  - size
```
public int size()
```
    Description copied from interface: AppendList
    
    Return size of this list.
    
    Specified by:
    
    size in interface AppendList<T extends Bytable>
  - clear
```
public void clear()
```
    Description copied from interface: AppendList
    
    Clear all elements.
    
    Specified by:
    
    clear in interface AppendList<T extends Bytable>
  - getMemoryCount
```
public long getMemoryCount()
```
    Returns:
    
    the memoryCount
  - getDiskCount
```
public long getDiskCount()
```
    Returns:
    
    the diskCount

Class BytableMemoryDiskList<T extends Bytable>

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

BytableMemoryDiskList

BytableMemoryDiskList

BytableMemoryDiskList

BytableMemoryDiskList

BytableMemoryDiskList

BytableMemoryDiskList

BytableMemoryDiskList

Method Detail

append

close

reOpen

iterator

switchState

size

clear

getMemoryCount

getDiskCount