com.googlecode.whatswrong.javautils
Class Counter<T>

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<T,Integer>
          com.googlecode.whatswrong.javautils.Counter<T>

All Implemented Interfaces:

Serializable, Cloneable, Map<T,Integer>

public class Counter<T>
extends HashMap<T,Integer>

A Counter counts objects of class T.

Author:

Sebastian Riedel

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Counter()

Method Summary

Integer	get(Object o) Gets the count of object o.
int	getMaximum() Gets the maximum count of all objects in the counter.
void	increment(T value, int howmuch) Increments the count for the given object by howmuch
static Counter<String>	loadFromFile(File file) Loads counts from a column separated file where row looks like "value count".
void	save(OutputStream outputStream) Saves the counts to column separated text file with format "value count" in each row.
List<Map.Entry<T,Integer>>	sorted(boolean descending) Sort map entries by counts.

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

Counter

public Counter()

Method Detail

get

public Integer get(Object o)

Gets the count of object o.

Specified by:

get in interface Map<T,Integer>

Overrides:

get in class HashMap<T,Integer>

Parameters:

o - the object to get the count of.

Returns:

the count of object o. If no count for o has specified zero is returned.

increment

public void increment(T value,
                      int howmuch)

Increments the count for the given object by howmuch

Parameters:

value - the object to increment the count for.

howmuch - how much the count should be incremented.

loadFromFile

public static Counter<String> loadFromFile(File file)
                                    throws IOException

Loads counts from a column separated file where row looks like "value count".

Parameters:

file - the file to load from.

Returns:

the Counter object representing the counts in the file

Throws:

IOException - if I/O goes wrong.

sorted

public List<Map.Entry<T,Integer>> sorted(boolean descending)

Sort map entries by counts.

Parameters:

descending - the list start with the highest or lowest count.

Returns:

a list of map entries ordered by count.

save

public void save(OutputStream outputStream)

Saves the counts to column separated text file with format "value count" in each row.

Parameters:

outputStream - the output stream to print to.

getMaximum

public int getMaximum()

Gets the maximum count of all objects in the counter.

Returns:

the maximum count of all objects in the counter.