Package com.pnfsoftware.jeb.util.collect

Class MultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

java.lang.Object

com.pnfsoftware.jeb.util.collect.MultiSegmentMap<K,V>

Type Parameters:

K - key/address type

V - segment type

All Implemented Interfaces:

IMultiSegmentMap<K,V>

@Ser
public class MultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>
extends Object
implements IMultiSegmentMap<K,V>

Standard implementation of a multi-segment map. This implementation relies on TreeMap.

Constructor Summary

Constructors

Modifier	Constructor	Description
	MultiSegmentMap()	Create a multi-segment map using natural key ordering.
protected	MultiSegmentMap(Comparator<? super K> comparator)	Create a multi-segment map using a custom key comparator.

Method Summary

Modifier and Type	Method	Description
V	add(V segment)	Add a segment.
void	clear()	Remove all segments.
int	compareKeys(K a, K b)	Compare two keys using this map's comparator.
V	getFirstSegmentContaining(K key)	Get one segment containing the provided key.
List<V>	getSegmentsContaining(K key)	Get all segments containing the provided key.
boolean	isEmpty()
int	size()

Methods inherited from class java.lang.Object

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

Constructor Details

MultiSegmentMap

public MultiSegmentMap()

Create a multi-segment map using natural key ordering.

MultiSegmentMap

protected MultiSegmentMap(Comparator<? super K> comparator)

Create a multi-segment map using a custom key comparator.

Parameters:

comparator - key comparator

Method Details

compareKeys

public int compareKeys(K a,
 K b)

Compare two keys using this map's comparator.

Parameters:

a - first key

b - second key

Returns:

comparison result

clear

public void clear()

Description copied from interface: IMultiSegmentMap

Remove all segments.

Specified by:

clear in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

Returns:

true if this map contains no segments

size

public int size()

Specified by:

size in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

Returns:

number of stored segments

add

public V add(V segment)

Description copied from interface: IMultiSegmentMap

Add a segment.

Specified by:

add in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

Parameters:

segment - segment to add

Returns:

added segment

getFirstSegmentContaining

public V getFirstSegmentContaining(K key)

Description copied from interface: IMultiSegmentMap

Get one segment containing the provided key.

Specified by:

getFirstSegmentContaining in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

Parameters:

key - key/address to probe

Returns:

first containing segment, or null if none was found

getSegmentsContaining

public List<V> getSegmentsContaining(K key)

Description copied from interface: IMultiSegmentMap

Get all segments containing the provided key.

Specified by:

getSegmentsContaining in interface IMultiSegmentMap<K extends Comparable<K>,V extends ISegment<K>>

Parameters:

key - key/address to probe

Returns:

list of containing segments