Package com.pnfsoftware.jeb.util.collect
Class ReferenceCounter<K>
java.lang.Object
com.pnfsoftware.jeb.util.collect.ReferenceCounter<K>
- Type Parameters:
K- counted object type
A simple, thread-safe object reference counter. A counter can be associated to any object of the
provided
K type.
Note that this utility class has nothing to do with Garbage Collection reference counting.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()Reset the reference counter.Copy the counters to a map.intUnrecord an object, i.e.Format all references in descending order.formatTopReferences(int top) Format the top references (= descending order) counted referenced by the counter.intGet the reference counter for an object.getAsMap()Get a read-only map of (referenced object -> count).intgetCount()Get the total count for all the references actively counted by this counter.booleanCheck if an object is currently referenced, i.e.intRecord an object, i.e.voidincAll(ReferenceCounter<K> other) Add a counter to this counter.booleanisEmpty()Determine whether there are references actively tracked by this counter.keys()Retrieve the tracked keys.voidload(Collection<? extends K> coll) Load a collection of objects by incrementing the counter for each object.orderedKeys(boolean descending) Retrieve keys ordered by their counters.booleanRemove an object from tracking.intsize()Get the number of references actively counted by this counter.toString()
-
Constructor Details
-
ReferenceCounter
public ReferenceCounter()Create a new reference counter.
-
-
Method Details
-
clear
public void clear()Reset the reference counter. -
isEmpty
public boolean isEmpty()Determine whether there are references actively tracked by this counter.- Returns:
- true if no object is tracked
-
size
public int size()Get the number of references actively counted by this counter.- Returns:
- number of distinct tracked objects
-
getCount
public int getCount()Get the total count for all the references actively counted by this counter.- Returns:
- sum of all counters
-
inc
Record an object, i.e. increment its reference counter. Will raise anIllegalStateExceptionif the counter exceeds the capacity of a signed integer.- Parameters:
key- object- Returns:
- the updated counter for this object
-
incAll
Add a counter to this counter.- Parameters:
other- other counter
-
dec
Unrecord an object, i.e. decrement its reference counter by one. If the object is currently untracked, an exception will be raised.- Parameters:
key- object- Returns:
- the updated counter for this object
- Throws:
IllegalArgumentException- if the object is not present
-
has
Check if an object is currently referenced, i.e. its reference counter is greater or equal than zero.- Parameters:
key- object- Returns:
- true if the object is referenced
-
get
Get the reference counter for an object.- Parameters:
key- object- Returns:
- the counter; 0 if the object is currently not tracked
-
getAsMap
Get a read-only map of (referenced object -> count). To be used in a "this counter"-synchronized block.- Returns:
- read-only view of the internal map
-
remove
Remove an object from tracking. This method is equivalent to decrementing the object counter until zero.- Parameters:
key- object- Returns:
- true if the object was actually referenced (i.e. its counter was >= 1), false if it was not
-
load
Load a collection of objects by incrementing the counter for each object.- Parameters:
coll- objects to count
-
keys
Retrieve the tracked keys.- Returns:
- copy of the key set
-
orderedKeys
Retrieve keys ordered by their counters.- Parameters:
descending- true to sort by descending counter values- Returns:
- ordered collection of keys
-
copyToMap
Copy the counters to a map.- Returns:
- copy of the counter map
-
toString
-
formatAllReferences
Format all references in descending order.- Returns:
- a string
-
formatTopReferences
Format the top references (= descending order) counted referenced by the counter.- Parameters:
top- the number of top references to format; a negative number means to format all references- Returns:
- a string
-