Progeneric.Ptl.Containers

Class FMapContainer64<TKey,TValue>

java.lang.Object

Progeneric.Ptl.Containers.FMapContainer64<TKey,TValue>

Type Parameters:

TKey - Specifies the type of keys in the maps.

TValue - Specifies the type of values in the maps.

Remarks: The container is persistent (stored on the hard drive) and can contain at most 281,474,976,710,656 maps.

All Implemented Interfaces:

IDisposable

public class FMapContainer64<TKey,TValue>
extends java.lang.Object
implements IDisposable

Defines a container that holds maps of a specified type using a resizable blkStorage.

Constructor Summary

Constructors

Constructor and Description
FMapContainer64(java.lang.Class<TKey> keyType, java.lang.Class<TValue> valueType) Creates an empty container that holds sequences of the specified type.
FMapContainer64(java.lang.Class<TKey> keyType, java.lang.Class<TValue> valueType, java.lang.String fileName, FileMode mode) Constructs an FMapContainer64 instance using the specified file.

Method Summary

Methods

Modifier and Type	Method and Description
void	Clear() Removes all maps from the parent container.
void	Close() Closes the file and releases any resources associated with the current buffered stream.
void	Dispose() Closes the file and releases any resources associated with the current buffered stream.
FMap64<TKey,TValue>	Item(long index) Gets the element at the specified position.
FMap64<TKey,TValue>	NewMap(boolean unique) Creates an empty index container using the default comparator.
FMap64<TKey,TValue>	NewMap(IFunc2Arg<TKey,TKey,java.lang.Boolean> keyCompare, boolean unique) Creates an empty index container using the specified comparator.
boolean	Remove(FMap64<TKey,TValue> list) Removes the specified object from the container.
long	Size() Returns the number of elements in the container.

Methods inherited from class java.lang.Object

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

Constructor Detail

FMapContainer64

public FMapContainer64(java.lang.Class<TKey> keyType,
               java.lang.Class<TValue> valueType)

Creates an empty container that holds sequences of the specified type.

Parameters:

keyType - The specified key type.

valueType - The specified value type.

FMapContainer64

public FMapContainer64(java.lang.Class<TKey> keyType,
               java.lang.Class<TValue> valueType,
               java.lang.String fileName,
               FileMode mode)

Constructs an FMapContainer64 instance using the specified file.

Parameters:

keyType - The specified key type.

valueType - The specified value type.

fileName - The specified file.

mode - A FileMode constant (Open or Create) that determines how to open or create the file.

Throws:

ArgumentException - Thrown when the specified mode is different than Open or Create.

Remarks: The container is persistent (saved on the hard drive), and the Close() method must always be called to flush the internal buffers.

Method Detail

Close

public void Close()

Closes the file and releases any resources associated with the current buffered stream.

Dispose

public void Dispose()

Closes the file and releases any resources associated with the current buffered stream.

Specified by:

Dispose in interface IDisposable

NewMap

public FMap64<TKey,TValue> NewMap(boolean unique)

Creates an empty index container using the default comparator.

Parameters:

unique - A boolean value indicating if the index allows duplicates.

NewMap

public FMap64<TKey,TValue> NewMap(IFunc2Arg<TKey,TKey,java.lang.Boolean> keyCompare,
                         boolean unique)

Creates an empty index container using the specified comparator.

Parameters:

keyCompare - The specified comparator.

unique - A boolean value indicating if the index allows duplicates.

Remove

public boolean Remove(FMap64<TKey,TValue> list)

Removes the specified object from the container.

Parameters:

list - The object to remove from the container.

Returns:

True if the specified object is successfully removed; otherwise, false. This method also returns false if item was not found in the sequence.

Size

public long Size()

Returns the number of elements in the container.

Item

public FMap64<TKey,TValue> Item(long index)

Gets the element at the specified position.

Parameters:

index - The zero-based index of the element to get. The element at the specified position.

Throws:

ArgumentOutOfRangeException - Thrown when the specified index is out of [0, Size - 1] range.

Clear

public void Clear()

Removes all maps from the parent container.