Package net.cscott.jutil

Class Factories

java.lang.Object

net.cscott.jutil.Factories

public final class Factories
extends Object

Factories consists exclusively of static methods that operate on or return CollectionFactorys.

Author:

Felix S. Klock II <pnkfelix@mit.edu>

Field Summary

Fields

Modifier and Type	Field	Description
static final ListFactory	arrayListFactory	Deprecated. Use arrayListFactory(), which is parameterized.
static final MapFactory	hashMapFactory	Deprecated. Use hashMapFactory(), which is parameterized.
static final SetFactory	hashSetFactory	Deprecated. Use hashSetFactory(), which is parameterized.
static final SetFactory	linearSetFactory	Deprecated. Use linearSetFactory(), which is parameterized.
static final MapFactory	linkedHashMapFactory	Deprecated. Use linkedHashMapFactory(), which is parameterized.
static final SetFactory	linkedHashSetFactory	Deprecated. Use linkedHashSetFactory(), which is parameterized.
static final ListFactory	linkedListFactory	Deprecated. Use linkedListFactory(), which is parameterized.
static final MapFactory	treeMapFactory	Deprecated. Use treeMapFactory(), which is parameterized.
static final SetFactory	treeSetFactory	Deprecated. Use treeSetFactory(), which is parameterized.
static final SetFactory	workSetFactory	Deprecated. Use linkedHashSetFactory(): WorkSet is deprecated in favor of LinkedHashSet.

Method Summary

Modifier and Type	Method	Description
static final <V> ListFactory<V>	arrayListFactory()
static final <K extends Enum<K>, V> MapFactory<K,V>	enumMapFactory(Class<K> enumClass)	A MapFactory that generates EnumMaps.
static final <V extends Enum<V>> SetFactory<V>	enumSetFactory(Class<V> enumClass)	A SetFactory that generates EnumSets.
static final <K, V> MapFactory<K,V>	hashMapFactory()
static final <V> SetFactory<V>	hashSetFactory()
static final <V> SetFactory<V>	linearSetFactory()
static final <K, V> MapFactory<K,V>	linkedHashMapFactory()	Returns a MapFactory that generates LinkedHashMaps.
static final <V> SetFactory<V>	linkedHashSetFactory()	Returns a SetFactory that generates LinkedHashSets.
static final <V> ListFactory<V>	linkedListFactory()
static <K, V> SetFactory<Map.Entry<K,V>>	mapSetFactory(MapFactory<K,V> mf)	Returns a SetFactory that generates MapSet views of maps generated by the given MapFactory.
static <K, V> SetFactory<Map.Entry<K,V>>	multiMapSetFactory(MultiMapFactory<K,V> mf)	Returns a SetFactory that generates MultiMapSet views of MultiMaps generated by the given MultiMapFactory.
static <V> CollectionFactory<V>	noNullCollectionFactory(CollectionFactory<V> cf)
static <V> CollectionFactory<V>	synchronizedCollectionFactory(CollectionFactory<V> cf)	Returns a CollectionFactory that generates synchronized (thread-safe) Collections.
static <V> ListFactory<V>	synchronizedListFactory(ListFactory<V> lf)	Returns a ListFactory that generates synchronized (thread-safe) Lists.
static <K, V> MapFactory<K,V>	synchronizedMapFactory(MapFactory<K,V> mf)	Returns a MapFactory that generates synchronized (thread-safe) Maps.
static <V> SetFactory<V>	synchronizedSetFactory(SetFactory<V> sf)	Returns a SetFactory that generates synchronized (thread-safe) Sets.
static final <K extends Comparable<K>, V> MapFactory<K,V>	treeMapFactory()	Returns a MapFactory that generates TreeMaps, in the keys' natural order.
static final <K, V> MapFactory<K,V>	treeMapFactory(Comparator<? super K> comp)	Returns a MapFactory that generates TreeMaps, ordered by comp.
static final <V extends Comparable<V>> SetFactory<V>	treeSetFactory()	Returns a SetFactory that generates TreeSets, in the elements' natural order.
static final <V> SetFactory<V>	treeSetFactory(Comparator<? super V> comp)	Returns a SetFactory that generates TreeSets, ordered by comp.
static final <V> SetFactory<V>	workSetFactory()	Deprecated. Use linkedHashSetFactory(): WorkSet is deprecated in favor of LinkedHashSet.

Methods inherited from class java.lang.Object

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

Field Details

hashMapFactory

@Deprecated(since="2.0")
public static final MapFactory hashMapFactory

Deprecated.

Use hashMapFactory(), which is parameterized.

A MapFactory that generates HashMaps.

linkedHashMapFactory

@Deprecated(since="2.0")
public static final MapFactory linkedHashMapFactory

Deprecated.

Use linkedHashMapFactory(), which is parameterized.

A MapFactory that generates LinkedHashMaps.

Since:

1.3

hashSetFactory

@Deprecated(since="2.0")
public static final SetFactory hashSetFactory

Deprecated.

Use hashSetFactory(), which is parameterized.

A SetFactory that generates HashSets.

linkedHashSetFactory

@Deprecated(since="2.0")
public static final SetFactory linkedHashSetFactory

Deprecated.

Use linkedHashSetFactory(), which is parameterized.

A SetFactory that generates LinkedHashSets.

Since:

1.3

workSetFactory

@Deprecated(since="2.0")
public static final SetFactory workSetFactory

Deprecated.

Use linkedHashSetFactory(): WorkSet is deprecated in favor of LinkedHashSet.

A SetFactory that generates WorkSets.

linearSetFactory

@Deprecated(since="2.0")
public static final SetFactory linearSetFactory

Deprecated.

Use linearSetFactory(), which is parameterized.

A SetFactory that generates LinearSets backed by ArrayLists.

treeSetFactory

@Deprecated(since="2.0")
public static final SetFactory treeSetFactory

Deprecated.

Use treeSetFactory(), which is parameterized.

A SetFactory that generates TreeSets.

treeMapFactory

@Deprecated(since="2.0")
public static final MapFactory treeMapFactory

Deprecated.

Use treeMapFactory(), which is parameterized.

A MapFactory that generates TreeMaps.

Since:

1.5

linkedListFactory

@Deprecated(since="2.0")
public static final ListFactory linkedListFactory

Deprecated.

Use linkedListFactory(), which is parameterized.

A ListFactory that generates LinkedLists.

arrayListFactory

@Deprecated(since="2.0")
public static final ListFactory arrayListFactory

Deprecated.

Use arrayListFactory(), which is parameterized.

Returns a ListFactory that generates ArrayLists.

Method Details

hashMapFactory

public static final <K,
V> MapFactory<K,V> hashMapFactory()

linkedHashMapFactory

public static final <K,
V> MapFactory<K,V> linkedHashMapFactory()

Returns a MapFactory that generates LinkedHashMaps.

Since:

1.3

enumMapFactory

public static final <K extends Enum<K>,
V>
MapFactory<K,V> enumMapFactory(Class<K> enumClass)

A MapFactory that generates EnumMaps.

Since:

1.3

hashSetFactory

public static final <V> SetFactory<V> hashSetFactory()

linkedHashSetFactory

public static final <V> SetFactory<V> linkedHashSetFactory()

Returns a SetFactory that generates LinkedHashSets.

Since:

1.3

enumSetFactory

public static final <V extends Enum<V>>
SetFactory<V> enumSetFactory(Class<V> enumClass)

A SetFactory that generates EnumSets.

Since:

1.3

workSetFactory

@Deprecated(since="2.0")
public static final <V> SetFactory<V> workSetFactory()

Deprecated.

Use linkedHashSetFactory(): WorkSet is deprecated in favor of LinkedHashSet.

A SetFactory that generates WorkSets.

linearSetFactory

public static final <V> SetFactory<V> linearSetFactory()

treeSetFactory

public static final <V extends Comparable<V>>
SetFactory<V> treeSetFactory()

Returns a SetFactory that generates TreeSets, in the elements' natural order.

treeSetFactory

public static final <V> SetFactory<V> treeSetFactory(Comparator<? super V> comp)

Returns a SetFactory that generates TreeSets, ordered by comp.

Since:

1.5

treeMapFactory

public static final <K extends Comparable<K>,
V>
MapFactory<K,V> treeMapFactory()

Returns a MapFactory that generates TreeMaps, in the keys' natural order.

Since:

1.5

treeMapFactory

public static final <K,
V> MapFactory<K,V> treeMapFactory(Comparator<? super K> comp)

Returns a MapFactory that generates TreeMaps, ordered by comp.

Since:

1.5

linkedListFactory

public static final <V> ListFactory<V> linkedListFactory()

arrayListFactory

public static final <V> ListFactory<V> arrayListFactory()

mapSetFactory

public static <K,
V> SetFactory<Map.Entry<K,V>> mapSetFactory(MapFactory<K,V> mf)

Returns a SetFactory that generates MapSet views of maps generated by the given MapFactory. These can be passed in as arguments to a GenericMultiMap, for example, to make a multimap of maps.

multiMapSetFactory

public static <K,
V> SetFactory<Map.Entry<K,V>> multiMapSetFactory(MultiMapFactory<K,V> mf)

Returns a SetFactory that generates MultiMapSet views of MultiMaps generated by the given MultiMapFactory. These can be passed in as arguments to a GenericMultiMap, for example, to make a multimap of multimaps.

synchronizedCollectionFactory

public static <V> CollectionFactory<V> synchronizedCollectionFactory(CollectionFactory<V> cf)

Returns a CollectionFactory that generates synchronized (thread-safe) Collections. The Collections generated are backed by the Collections generated by cf.

See Also:

• Collections.synchronizedCollection(java.util.Collection<T>)

synchronizedSetFactory

public static <V> SetFactory<V> synchronizedSetFactory(SetFactory<V> sf)

Returns a SetFactory that generates synchronized (thread-safe) Sets. The Sets generated are backed by the Sets generated by sf.

See Also:

• Collections.synchronizedSet(java.util.Set<T>)

synchronizedListFactory

public static <V> ListFactory<V> synchronizedListFactory(ListFactory<V> lf)

Returns a ListFactory that generates synchronized (thread-safe) Lists. The Lists generated are backed by the Lists generated by lf.

See Also:

• Collections.synchronizedList(java.util.List<T>)

synchronizedMapFactory

public static <K,
V> MapFactory<K,V> synchronizedMapFactory(MapFactory<K,V> mf)

Returns a MapFactory that generates synchronized (thread-safe) Maps. The Maps generated are backed by the Map generated by mf.

See Also:

• Collections.synchronizedMap(java.util.Map<K, V>)

noNullCollectionFactory

public static <V> CollectionFactory<V> noNullCollectionFactory(CollectionFactory<V> cf)