FunctionUtils (Paguro (formerly known as "UncleJim") 2.0.19 API)

java.lang.Object
- org.organicdesign.fp.FunctionUtils

```
public class FunctionUtils
extends Object
```
A dumping ground for utility functions that aren't useful enough to belong in StaticImports. The unmod___() methods are an alternative to Collections.unmodifiable____(). They provide unmodifiable wrappers to protect mutable collections for sharing. Except for the Iterators, the returned classes are Serializable. These will never return null, the closest they get is to return an empty unmodifiable collection. The unmodifiable interfaces they return have deprecated the modification methods so that any attempt to use those methods causes a warning in your IDE and compiler.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FunctionUtils.UnmodifiableCollection<T>` Wraps a collection.
`static class`	`FunctionUtils.UnmodifiableIterator<E>` Wraps an iterator.
`static class`	`FunctionUtils.UnmodifiableList<T>` Wraps a list.
`static class`	`FunctionUtils.UnmodifiableListIterator<T>` Wraps a list iterator.
`static class`	`FunctionUtils.UnmodifiableMap<K,V>` Wraps a map.
`static class`	`FunctionUtils.UnmodifiableSet<T>` Wraps a set.
`static class`	`FunctionUtils.UnmodifiableSortedIterator<E>` Wraps an ordered iterator.
`static class`	`FunctionUtils.UnmodifiableSortedMap<K,V>` Wraps a sorted map.
`static class`	`FunctionUtils.UnmodifiableSortedSet<T>` Wraps a sorted set.

Field Summary

Fields
Modifier and Type	Field and Description
`static UnmodCollection<Object>`	`EMPTY_UNMOD_COLLECTION` Deprecated.
`static UnmodIterator<?>`	`EMPTY_UNMOD_ITERATOR` Deprecated.
`static UnmodList<?>`	`EMPTY_UNMOD_LIST` Deprecated.
`static UnmodListIterator<Object>`	`EMPTY_UNMOD_LIST_ITERATOR` Deprecated.
`static UnmodMap<Object,Object>`	`EMPTY_UNMOD_MAP` Deprecated.
`static UnmodSet<Object>`	`EMPTY_UNMOD_SET` Deprecated.
`static UnmodSortedIterator<Object>`	`EMPTY_UNMOD_SORTED_ITERATOR` Deprecated.
`static UnmodSet<Object>`	`EMPTY_UNMOD_SORTED_SET` Deprecated.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> UnmodCollection<T>`	`emptyUnmodCollection()` Returns an empty unmodifiable Collection.
`static <T> FunctionUtils.UnmodifiableIterator<T>`	`emptyUnmodIterator()` Returns an empty unmodifiable iterator.
`static <T> UnmodList<T>`	`emptyUnmodList()` Returns an empty unmodifiable list.
`static <T> UnmodListIterator<T>`	`emptyUnmodListIterator()` Returns an empty list iterator.
`static <T,U> UnmodMap<T,U>`	`emptyUnmodMap()` Returns an empty unmodifiable map.
`static <T> UnmodSet<T>`	`emptyUnmodSet()` Returns an empty unmodifiable set.
`static <T> UnmodSortedIterator<T>`	`emptyUnmodSortedIterator()` Only use this where Sorted items are called for.
`static <T,U> UnmodSortedMap<T,U>`	`emptyUnmodSortedMap()` Returns an empty unmodifiable sorted map.
`static <T> UnmodSortedSet<T>`	`emptyUnmodSortedSet()` Returns an empty unmodifiable sorted set.
`static String`	`ordinal(int origI)`
`static String`	`stringify(Object o)`
`static <T> UnmodCollection<T>`	`unmodCollection(Collection<T> coll)` Returns an unmodifiable version of the given collection.
`static <T> UnmodIterator<T>`	`unmodIterator(Iterator<T> iter)` Returns an unmodifiable version of the given iterator.
`static <T> UnmodList<T>`	`unmodList(List<T> inner)` Returns an unmodifiable version of the given list.
`static <T> UnmodListIterator<T>`	`unmodListIterator(ListIterator<T> iter)` Returns an unmodifiable version of the given listIterator.
`static <K,V> UnmodMap<K,V>`	`unmodMap(Map<K,V> map)` Returns an unmodifiable version of the given map.
`static <T> UnmodSet<T>`	`unmodSet(Set<T> set)` Returns an unmodifiable version of the given set.
`static <T> UnmodSortedIterator<T>`	`unmodSortedIterator(Iterator<T> iter)` Returns an unmodifiable version of the given ordered Iterator.
`static <K,V> UnmodSortedMap<K,V>`	`unmodSortedMap(SortedMap<K,V> map)` Returns an unmodifiable version of the given sorted map.
`static <T> UnmodSortedSet<T>`	`unmodSortedSet(SortedSet<T> set)` Returns an unmodifiable version of the given set.

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

- Field Detail
  - EMPTY_UNMOD_ITERATOR
```
@Deprecated
public static final UnmodIterator<?> EMPTY_UNMOD_ITERATOR
```
    Deprecated.
    
    Use emptyUnmodIterator() instead.
  - EMPTY_UNMOD_LIST_ITERATOR
```
@Deprecated
public static final UnmodListIterator<Object> EMPTY_UNMOD_LIST_ITERATOR
```
    Deprecated.
    
    Use emptyUnmodListIterator() instead.
  - EMPTY_UNMOD_LIST
```
@Deprecated
public static final UnmodList<?> EMPTY_UNMOD_LIST
```
    Deprecated.
    
    Use emptyUnmodList() instead
  - EMPTY_UNMOD_SET
```
@Deprecated
public static final UnmodSet<Object> EMPTY_UNMOD_SET
```
    Deprecated.
    
    Use emptyUnmodSet() instead.
  - EMPTY_UNMOD_SORTED_ITERATOR
```
@Deprecated
public static final UnmodSortedIterator<Object> EMPTY_UNMOD_SORTED_ITERATOR
```
    Deprecated.
    
    Use emptyUnmodSortedIterator() instead
  - EMPTY_UNMOD_SORTED_SET
```
@Deprecated
public static final UnmodSet<Object> EMPTY_UNMOD_SORTED_SET
```
    Deprecated.
    
    Use emptyUnmodSortedSet() instead
  - EMPTY_UNMOD_MAP
```
@Deprecated
public static final UnmodMap<Object,Object> EMPTY_UNMOD_MAP
```
    Deprecated.
    
    Use emptyUnmodMap() instead.
  - EMPTY_UNMOD_COLLECTION
```
@Deprecated
public static final UnmodCollection<Object> EMPTY_UNMOD_COLLECTION
```
    Deprecated.
    
    Use emptyUnmodCollection() instead
- Method Detail
  - stringify
```
public static String stringify(Object o)
```
  - ordinal
```
public static String ordinal(int origI)
```
  - emptyUnmodIterator
```
public static <T> FunctionUtils.UnmodifiableIterator<T> emptyUnmodIterator()
```
    Returns an empty unmodifiable iterator. The result is not serializable.
  - emptyUnmodSortedIterator
```
public static <T> UnmodSortedIterator<T> emptyUnmodSortedIterator()
```
    Only use this where Sorted items are called for. Returns an empty unmodifiable sorted iterator. The result is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned iterator with the == operator.
  - emptyUnmodListIterator
```
public static <T> UnmodListIterator<T> emptyUnmodListIterator()
```
    Returns an empty list iterator. The result is NOT serializable.
  - emptyUnmodList
```
public static <T> UnmodList<T> emptyUnmodList()
```
    Returns an empty unmodifiable list. The result is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned list with the == operator.
  - emptyUnmodSet
```
public static <T> UnmodSet<T> emptyUnmodSet()
```
    Returns an empty unmodifiable set. The result is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned set with the == operator.
  - emptyUnmodSortedSet
```
public static <T> UnmodSortedSet<T> emptyUnmodSortedSet()
```
    Returns an empty unmodifiable sorted set. The result is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned set with the == operator.
  - emptyUnmodMap
```
public static <T,U> UnmodMap<T,U> emptyUnmodMap()
```
    Returns an empty unmodifiable map. The result is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned map with the == operator.
  - emptyUnmodSortedMap
```
public static <T,U> UnmodSortedMap<T,U> emptyUnmodSortedMap()
```
    Returns an empty unmodifiable sorted map. This is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned map with the == operator.
  - emptyUnmodCollection
```
public static <T> UnmodCollection<T> emptyUnmodCollection()
```
    Returns an empty unmodifiable Collection. Avoid this when possible because there is no way to compare Collections for equality (they could be Lists or Sets). This is serializable, but deserialization will produce a new, unique object. For this reason, you should not compare the returned collection with the == operator.
  - unmodIterator
```
public static <T> UnmodIterator<T> unmodIterator(Iterator<T> iter)
```
    Returns an unmodifiable version of the given iterator. The result is NOT serializable. You could pass a partially used-up iterator to this method, but that's probably something you want to avoid.
  - unmodSortedIterator
```
public static <T> UnmodSortedIterator<T> unmodSortedIterator(Iterator<T> iter)
```
    Returns an unmodifiable version of the given ordered Iterator. Only use where items are ordered/sorted such as from a List or SortedSet that guarantees order. The result is NOT serializable.
  - unmodListIterator
```
public static <T> UnmodListIterator<T> unmodListIterator(ListIterator<T> iter)
```
    Returns an unmodifiable version of the given listIterator. The result is NOT serializable.
  - unmodList
```
public static <T> UnmodList<T> unmodList(List<T> inner)
```
    Returns an unmodifiable version of the given list. The returned list is serializable to the extent that the given list is serializable.
  - unmodSet
```
public static <T> UnmodSet<T> unmodSet(Set<T> set)
```
    Returns an unmodifiable version of the given set. The result is serializable to the extent that the given set is serializable.
  - unmodSortedSet
```
public static <T> UnmodSortedSet<T> unmodSortedSet(SortedSet<T> set)
```
    Returns an unmodifiable version of the given set. The result is serializable to the extent that the given set is serializable. A common serialization mistake is to define a comparator with an anonymous class or function, or otherwise rely on a comparator which cannot be serialized. The resulting deserialized set will take the default ordering (or could throw an error). Since comparators are usually singletons, an Enum is probably the best way to implement one.
  - unmodMap
```
public static <K,V> UnmodMap<K,V> unmodMap(Map<K,V> map)
```
    Returns an unmodifiable version of the given map. The result is serializable to the extent that the given map is serializable.
  - unmodSortedMap
```
public static <K,V> UnmodSortedMap<K,V> unmodSortedMap(SortedMap<K,V> map)
```
    Returns an unmodifiable version of the given sorted map. The result is serializable to the extent that the given map is serializable. A common serialization mistake is to define a comparator with an anonymous class or function, or otherwise rely on a comparator which cannot be serialized. The resulting deserialized map will take the default ordering (or could throw an error). Since comparators are usually singletons, an Enum is probably the best way to implement one.
  - unmodCollection
```
public static <T> UnmodCollection<T> unmodCollection(Collection<T> coll)
```
    Returns an unmodifiable version of the given collection. This class is too vague to be compared for equality. Both List and Set are collections, but neither consider themselves equal to any Collection, and indeed their notions of equality are incompatible. The returned collection is serializable to the extent that the wrapped collection is.

Class FunctionUtils

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_UNMOD_ITERATOR

EMPTY_UNMOD_LIST_ITERATOR

EMPTY_UNMOD_LIST

EMPTY_UNMOD_SET

EMPTY_UNMOD_SORTED_ITERATOR

EMPTY_UNMOD_SORTED_SET

EMPTY_UNMOD_MAP

EMPTY_UNMOD_COLLECTION

Method Detail

stringify

ordinal

emptyUnmodIterator

emptyUnmodSortedIterator

emptyUnmodListIterator

emptyUnmodList

emptyUnmodSet

emptyUnmodSortedSet

emptyUnmodMap

emptyUnmodSortedMap

emptyUnmodCollection

unmodIterator

unmodSortedIterator

unmodListIterator

unmodList

unmodSet

unmodSortedSet

unmodMap

unmodSortedMap

unmodCollection