CounterSet (Teamscale Check Framework API)

java.lang.Object
- org.conqat.lib.commons.collections.CounterSet<E>

All Implemented Interfaces:

java.io.Serializable, java.lang.Iterable<Pair<E,java.lang.Integer>>

Direct Known Subclasses:

SortedCounterSet
```
public class CounterSet<E>
extends java.lang.Object
implements java.io.Serializable, java.lang.Iterable<Pair<E,java.lang.Integer>>
```
This class manages a set of counters (i.e. is a mapping from some key objects to integers). As the implementation is based on hash maps, key objects must provide suitable hash keys.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected java.util.Map<E,java.lang.Integer> map
The underlying map.

protected int total
Stores total value.

Fields
Modifier and Type	Field and Description
`protected java.util.Map<E,java.lang.Integer>`	`map` The underlying map.
`protected int`	`total` Stores total value.

Constructor Summary

Constructors
Constructor and Description
`CounterSet()` Constructs an empty `CounterSet`.
`CounterSet(java.util.Collection<E> keys)` Constructs a new `CounterSet` from the given keys.
`CounterSet(E key, int value)` Constructs a CounterSet with one value.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(CounterSet<E> other)` Adds the given `CounterSet` to this `CounterSet` by incrementing all keys contained from other.
`void`	`clear()` Clears the counter set.
`boolean`	`contains(E key)` Checks if an element is stored in the array.
`boolean`	`equals(java.lang.Object obj)`
`UnmodifiableSet<E>`	`getKeys()` Returns the set of all elements used a keys for counters.
`java.util.List<E>`	`getKeysByValueAscending()` Returns a list of all keys ordered by their value ascending
`java.util.List<E>`	`getKeysByValueDescending()` Returns a list of all keys ordered by their value descending
`int`	`getTotal()` Get total sum of all elements.
`int`	`getValue(E key)` Get the value for an element.
`int`	`hashCode()`
`int`	`inc(E key)` Same as `inc(key, 1)`.
`int`	`inc(E key, int increment)` Add the given increment to an element.
`void`	`incAll(java.util.Collection<E> keys)` Increments the given elements by 1
`void`	`incAll(java.util.Collection<E> keys, int increment)` Add the given increment to the given keys.
`java.util.Iterator<Pair<E,java.lang.Integer>>`	`iterator()`
`void`	`printValueDistribution(boolean ascending)` Prints the distribution of values (ascending or descending) to System.out, where each value is printed on a separate line in the form <key> : <value>.
`void`	`printValueDistribution(java.io.PrintWriter writer, boolean ascending)` Prints the distribution of values (ascending or descending) to the given stream, where each value is printed on a separate line in the form <key> : <value>.
`void`	`remove(E key)` Remove the entry with the given key, i.e.
`void`	`removeAll(java.util.Collection<E> keys)` Removes all entries with the given keys.
`void`	`removeIf(java.util.function.BiFunction<E,java.lang.Integer,java.lang.Boolean> filter)` Removes all keys that the given filter matches.
`static <E> CounterSet<E>`	`removeSecondFromFirst(CounterSet<E> first, CounterSet<E> second)` Removes the second CounterSet from the first one and returns a new CounterSet.
`java.util.Map<E,java.lang.Integer>`	`toMap()` Returns the values as `Map`.
`java.util.Map<E,java.lang.Integer>`	`toMapWithoutZeroEntries()` Returns the values as a `Map`, but omits keys where the value is 0.
`java.lang.String`	`toString()`
`java.util.Collection<java.lang.Integer>`	`values()` Returns a collection of all values

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - map
```
protected final java.util.Map<E,java.lang.Integer> map
```
    The underlying map.
  - total
```
protected int total
```
    Stores total value.
- Constructor Detail
  - CounterSet
```
public CounterSet()
```
    Constructs an empty CounterSet.
  - CounterSet
```
public CounterSet(java.util.Collection<E> keys)
```
    Constructs a new CounterSet from the given keys. Initializes all keys with 1.
  - CounterSet
```
public CounterSet(E key,
                  int value)
```
    Constructs a CounterSet with one value.
- Method Detail
  - inc
```
public int inc(E key,
               int increment)
```
    Add the given increment to an element. If the element was not present before, it is interpreted as if it was present with value 0. Returns the new value.
    
    Parameters:
    
    key - the key of the counter to increment.
    
    increment - the increment.
  - inc
```
public int inc(E key)
```
    Same as inc(key, 1).
    
    See Also:
    
    inc(Object, int)
  - incAll
```
public void incAll(java.util.Collection<E> keys,
                   int increment)
```
    Add the given increment to the given keys. If a key was not present before, it is interpreted as if it was present with value 0.
    
    Parameters:
    
    keys - the keys of the counter to increment.
    
    increment - the increment.
  - incAll
```
public void incAll(java.util.Collection<E> keys)
```
    Increments the given elements by 1
  - add
```
public void add(CounterSet<E> other)
```
    Adds the given CounterSet to this CounterSet by incrementing all keys contained from other.
  - removeSecondFromFirst
```
public static <E> CounterSet<E> removeSecondFromFirst(CounterSet<E> first,
                                                      CounterSet<E> second)
```
    Removes the second CounterSet from the first one and returns a new CounterSet.
  - removeIf
```
public void removeIf(java.util.function.BiFunction<E,java.lang.Integer,java.lang.Boolean> filter)
```
    Removes all keys that the given filter matches.
  - remove
```
public void remove(E key)
```
    Remove the entry with the given key, i.e. sets its value to 0. In case the entry does not exist, nothing happens.
  - removeAll
```
public void removeAll(java.util.Collection<E> keys)
```
    Removes all entries with the given keys.
  - clear
```
public void clear()
```
    Clears the counter set.
  - contains
```
public boolean contains(E key)
```
    Checks if an element is stored in the array.
  - getValue
```
public int getValue(E key)
```
    Get the value for an element. If the the element is not stored in the counter 0 is returned.
  - getKeys
```
public UnmodifiableSet<E> getKeys()
```
    Returns the set of all elements used a keys for counters.
  - getKeysByValueAscending
```
public java.util.List<E> getKeysByValueAscending()
```
    Returns a list of all keys ordered by their value ascending
  - getKeysByValueDescending
```
public java.util.List<E> getKeysByValueDescending()
```
    Returns a list of all keys ordered by their value descending
  - getTotal
```
public int getTotal()
```
    Get total sum of all elements.
  - values
```
public java.util.Collection<java.lang.Integer> values()
```
    Returns a collection of all values
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - printValueDistribution
```
public void printValueDistribution(boolean ascending)
```
    Prints the distribution of values (ascending or descending) to System.out, where each value is printed on a separate line in the form <key> : <value>.
    Example:
    foo : 4
    bar : 2
  - printValueDistribution
```
public void printValueDistribution(java.io.PrintWriter writer,
                                   boolean ascending)
```
    Prints the distribution of values (ascending or descending) to the given stream, where each value is printed on a separate line in the form <key> : <value>.
    Example:
    foo : 4
    bar : 2
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toMap
```
public java.util.Map<E,java.lang.Integer> toMap()
```
    Returns the values as Map.
  - toMapWithoutZeroEntries
```
public java.util.Map<E,java.lang.Integer> toMapWithoutZeroEntries()
```
    Returns the values as a Map, but omits keys where the value is 0.
  - iterator
```
public java.util.Iterator<Pair<E,java.lang.Integer>> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<Pair<E,java.lang.Integer>>

Class CounterSet<E>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

map

total

Constructor Detail

CounterSet

CounterSet

CounterSet

Method Detail

inc

inc

incAll

incAll

add

removeSecondFromFirst

removeIf

remove

removeAll

clear

contains

getValue

getKeys

getKeysByValueAscending

getKeysByValueDescending

getTotal

values

toString

printValueDistribution

printValueDistribution

equals

hashCode

toMap

toMapWithoutZeroEntries

iterator