Package org.plumelib.util

Plume-lib Util: Utility libraries for Java

See: Description

Interface Summary

Interface	Description
Filter<T>	Interface for things that make boolean decisions.
Hasher	Hasher is intended to work like Comparable: it is an optional argument to a hashing data structure (such as a HashSet, HashMap, or WeakHashMap) which specifies the hashCode() and equals() methods.
Partitioner<ELEMENT,CLASS>	A Partitioner accepts Objects and assigns them to an equivalence class.
UniqueId	An interface for objects that have a unique ID (unique identifier).

Class Summary

Class	Description
ArraysPlume	Utilities for manipulating arrays and collections.
ArraysPlume.ComparableArrayComparatorLengthFirst<T extends java.lang.Comparable<T>>	Compare two arrays first by length (a shorter array is considered less), and if of equal length compare lexically (element-by-element).
ArraysPlume.ComparableArrayComparatorLexical<T extends java.lang.Comparable<T>>	Compare two arrays lexically (element-by-element).
ArraysPlume.DoubleArrayComparatorLexical	Compare two arrays lexically (element-by-element).
ArraysPlume.IntArrayComparatorLengthFirst	Compare two arrays first by length (a shorter array is considered less), and if of equal length compare lexically (element-by-element).
ArraysPlume.IntArrayComparatorLexical	Compare two arrays lexically (element-by-element).
ArraysPlume.LongArrayComparatorLengthFirst	Compare two arrays first by length (a shorter array is considered less), and if of equal length compare lexically (element-by-element).
ArraysPlume.LongArrayComparatorLexical	Compare two arrays lexically (element-by-element).
ArraysPlume.ObjectArrayComparatorLengthFirst	Compare two arrays first by length (a shorter array is considered less), and if of equal length compare lexically (element-by-element).
ArraysPlume.ObjectArrayComparatorLexical	Compare two arrays lexically (element-by-element).
ArraysPlume.StringArrayComparatorLexical	Compare two arrays lexically (element-by-element).
ClassDeterministic	Deterministic versions of java.lang.Class methods, which return arrays in sorted order.
CollectionsPlume	Utility functions for Collections, ArrayList, Iterator, and Map.
CollectionsPlume.EnumerationIterator<T>	Converts an Enumeration into an Iterator.
CollectionsPlume.FilteredIterator<T>	An iterator that only returns elements that match the given Filter.
CollectionsPlume.IteratorEnumeration<T>	Converts an Iterator into an Enumeration.
CollectionsPlume.MergedIterator<T>	An Iterator that returns the elements in each of its argument Iterators, in turn.
CollectionsPlume.MergedIterator2<T>	An Iterator that returns first the elements returned by its first argument, then the elements returned by its second argument.
CollectionsPlume.RemoveFirstAndLastIterator<T>	Returns an iterator just like its argument, except that the first and last elements are removed.
CombinationIterator<T>	Given a set of collections, yield each combination that takes one element from each collection.
DeterministicObject	This is a deterministic version of the Object class.
DumpHeap	Defines a method DumpHeap.dumpHeap(java.lang.String) that dumps the heap to an .hprof file.
EntryReader	Class that reads records or "entries" from a file.
EntryReader.Entry	Descriptor for an entry (record, paragraph, etc.).
FileWriterWithName	Just like FileWriter, but adds a FileWriterWithName.getFileName() method and overrides #toString() to give the file name.
FuzzyFloat	Routines for doing approximate ('fuzzy') floating-point comparisons.
GraphPlume	Graph utility methods.
ImmutableTypes	Records all the immutable types in the JDK, and can be queried.
Intern	Utilities for interning objects.
LimitedSizeIntSet	LimitedSizeIntSet stores up to some maximum number of unique values.
LimitedSizeLongSet	LimitedSizeLongSet stores up to some maximum number of unique values.
LimitedSizeSet<T>	LimitedSizeSet stores up to some maximum number of unique values.
MathPlume	Mathematical utilities.
MultiRandSelector<T>	Performs uniform random selection over an iterator, where the objects in the iterator may be partitioned so that the random selection chooses the same number from each group.
OrderedPairIterator<T>	Given two sorted iterators, this class returns a new iterator that pairs equal elements of the inputs, according to the sort order or the given comparator.
Pair<T1,T2>	Mutable pair class: type-safely holds two objects of possibly-different types.
RandomSelector<T>	RandomSelector selects k elements uniformly at random from an arbitrary iterator, using O(k) space.
RegexUtil	Utility methods for regular expressions, most notably for testing whether a string is a regular expression.
StringsPlume	Utility functions that manipulate Strings: replacement; prefixing and indentation; splitting and joining; quoting and escaping; whitespace; comparisons; StringTokenizer; debugging variants of toString; diagnostic output; miscellaneous.
StringsPlume.NullableStringComparator	Same as built-in String comparison, but accept null arguments, and place them at the beginning.
StringsPlume.ObjectComparator	Attempt to order Objects.
SystemPlume	Utility methods relating to the JVM runtime system: sleep and garbage collection.
ToStringComparator	A comparator that orders values based on the lexicographic ordering of their toString().
UniqueIdMap<E>	Provides a unique ID for classes that you cannot modify.
UtilPlume	Utility methods that do not belong elsewhere in the plume package: BitSet; File; directories; file names; reading and writing; hashing; ProcessBuilder; properties; Stream; Throwable.
UtilPlume.NullableStringComparator	Deprecated use StringsPlume.NullableStringComparator
UtilPlume.ObjectComparator	Deprecated use StringsPlume.ObjectComparator
UtilPlume.WildcardFilter	A FilenameFilter that accepts files whose name matches the given wildcard.
WeakHasherMap<K,V>	This is a modified version of WeakHashMap from JDK 1.2.2, that adds a constructor that takes a Hasher argument.
WeakIdentityHashMap<K,V>	This class combines the features of WeakHashMap and IdentityHashMap.
WeakIdentityPair<T1,T2>	Immutable pair class: type-safely holds two objects of possibly-different types.

Exception Summary

Exception	Description
FileIOException	This class extends IOException by also reporting a file name and line number at which the exception occurred.
RegexUtil.CheckedPatternSyntaxException	A checked version of PatternSyntaxException.

Package org.plumelib.util Description

Plume-lib Util: Utility libraries for Java

Collections and iterators

ArraysPlume

Utilities for manipulating arrays and collections. This complements java.util.Arrays and java.util.Collections.

CollectionsPlume

Utilities for manipulating collections, iterators, lists, maps, and sets.

CombinationIterator

Given a set of collections, return all combinations that take one element from each collection.

LimitedSizeSet

Stores up to some maximum number of unique values, at which point its rep is nulled, in order to save space.

LimitedSizeIntSet

Stores up to some maximum number of unique integer values, at which point its rep is nulled, in order to save space. More efficient than LimitedSizeSet<Integer>.

LimitedSizeLongSet

Stores up to some maximum number of unique long values, at which point its rep is nulled, in order to save space. More efficient than LimitedSizeSet<Long>.

OrderedPairIterator

Given two sequences/iterators/whatever, OrderedPairIterator returns a new sequence/iterator/whatever that pairs the matching elements of the inputs, according to their respective sort orders. (This operation is sometimes called "zipping".)

WeakHasherMap

WeakHashMap is a modified version of WeakHashMap from JDK 1.2.2, that adds a constructor that takes a Hasher argument.

WeakIdentityHashMap

WeakIdentityHashMap is a modified version of WeakHashMap from JDK 1.5, that uses System.identityHashCode() rather than the object's hash code.

Text processing

StringsPlume

Utility methods that manipulate Strings: replacement; prefixing and indentation; splitting and joining; quoting and escaping; whitespace; comparisons; StringTokenizer; debugging variants of toString; diagnostic output; miscellaneous.

EntryReader

Class that reads "entries" from a file. In the simplest case, entries can be lines. It supports: include files, comments, and multi-line entries (paragraphs). The syntax of each of these is customizable.

RegexUtil

Utility methods for regular expressions, most notably for testing whether a string is a regular expression.

FileIOException

Extends IOException by also reporting a file name and line number at which the exception occurred.

FileWriterWithName

Just like FileWriter, but adds a getFileName() method and overrides toString() to give the file name.

Math

MathPlume

Mathematical utilities.

FuzzyFloat

Routines for doing approximate ('fuzzy') floating point comparisons. Those are comparisons that only require the floating point numbers to be relatively close to one another to be equal, rather than exactly equal.

Random selection

RandomSelector

Selects k elements uniformly at random from an arbitrary iterator, using O(k) space.

MultiRandSelector

Like RandomSelector, performs a uniform random selection over an iterator. However, the objects in the iteration may be partitioned so that the random selection chooses the same number from each group.

Determinism and immutability

DeterministicObject

A version of Object with a deterministic hashCode() method. Instantiate this instead of Object to remove a source of nondeterminism from your programs.

ClassDeterministic

Deterministic versions of java.lang.Class methods, which return arrays in sorted order.

UniqueId

An interface for objects that have a unique ID. If you are tempted to print the value of System.identityHashCode(), consider using this instead.

UniqueIdMap

Provides a unique ID (like the UniqueId class) for classes that you cannot modify.

ImmutableTypes

Indicates which types in the JDK are immutable.

Utility interfaces

Filter

Interface for things that make boolean decisions. This is inspired by java.io.FilenameFilter.

Partitioner

A Partitioner accepts Objects and assigns them to an equivalence class.

JVM runtime system

DumpHeap

Dumps the heap into a .hprof file.

SystemPlume

Utility methods relating to the JVM runtime system: sleep and garbage collection.

Miscellaneous

GraphPlume

Graph utility methods. This class does not model a graph: all methods are static.

Intern

Utilities for interning objects. Interning is also known as canonicalization or hash-consing: it returns a single representative object that .equals() the object, and the client discards the argument and uses the result instead.

Pair

Mutable pair class: type-safely holds two objects of possibly-different types.

WeakIdentityPair

Immutable pair class: type-safely holds two objects of possibly-different types. Differs from Pair in the following ways: is immutable, cannot hold null, holds its elements with weak pointers, and its equals() method uses object equality to compare its elements.

UtilPlume

Utility methods that do not belong elsewhere in the plume package: BitSet; File; directories; file names; reading and writing; hashing; ProcessBuilder; properties; Stream; Throwable.