com.hp.util

Class TallyMapLong<K>

java.lang.Object

com.hp.util.TallyMapLong<K>

Type Parameters:

K - the key type

public class TallyMapLong<K>
extends Object

This class maintains a map of (long) counts. Note that this class is not synchronized.

Author:

Simon Hunt

See Also:

TallyMap

Constructor Summary

Constructors

Constructor and Description
TallyMapLong()

Method Summary

Methods

Modifier and Type	Method and Description
long	dec(K key) Decrement the count associated with the specified key by 1.
long	dec(K key, long amount) Decrement the count associated with the specified key by the given amount.
long	get(K key) Returns the count associated with the specified key.
K	getHighestKey() Returns the key that is "highest" in the natural ordering of the K class, and is also present (has a non-zero count) in the map.
Set<K>	getKeys() Returns the key set for the backing map.
long	getTotal() Returns the sum of all values in the map; i.e. the Grand Total.
long	inc(K key) Increment the count associated with the specified key by 1.
long	inc(K key, long amount) Increment the count associated with the specified key by the given amount.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TallyMapLong

public TallyMapLong()

Method Detail

toString

public String toString()

Overrides:

toString in class Object

inc

public long inc(K key)

Increment the count associated with the specified key by 1. If key is null, 0 is returned.

Parameters:

key - the key

Returns:

the value of the count after we have incremented it

inc

public long inc(K key,
       long amount)

Increment the count associated with the specified key by the given amount. If key is null, 0 is returned.

Parameters:

key - the key

amount - the amount to increment by

Returns:

the value of the count after we have incremented it

dec

public long dec(K key)

Decrement the count associated with the specified key by 1. If key is null, 0 is returned.

Parameters:

key - the key

Returns:

the value of the count after we have decremented it

dec

public long dec(K key,
       long amount)

Decrement the count associated with the specified key by the given amount. If key is null, 0 is returned.

Parameters:

key - the key

amount - the amount to decrement by

Returns:

the value of the count after we have decremented it

get

public long get(K key)

Returns the count associated with the specified key. If key is null, 0 is returned.

Parameters:

key - the key

Returns:

the value of the count

getKeys

public Set<K> getKeys()

Returns the key set for the backing map. Take care, because changes to the map will change the contents of your set and vice versa!

Returns:

the backing map key set

getTotal

public long getTotal()

Returns the sum of all values in the map; i.e. the Grand Total.

Returns:

the grand total

getHighestKey

public K getHighestKey()

Returns the key that is "highest" in the natural ordering of the K class, and is also present (has a non-zero count) in the map.

Returns:

the highest key