CollectionFactory (OWLAPI :: Distribution 5.0.5 API)

java.lang.Object
- org.semanticweb.owlapi.util.CollectionFactory

```
public class CollectionFactory
extends Object
```
Since:

2.0.0

Author:

Matthew Horridge, The University Of Manchester, Bio-Health Informatics Group

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CollectionFactory.ConditionalCopySet<T>` a set implementation that uses a delegate collection for all read-only operations and makes a copy if changes are attempted.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> Set<T>`	`copy(Collection<T> source)`
`static <T> Set<T>`	`copyMutable(Collection<T> source)`
`static <T> Set<T>`	`createLinkedSet()`
`static <T> List<T>`	`createList()`
`static <T> List<T>`	`createList(T... elements)`
`static <K,V> Map<K,V>`	`createMap()`
`static <T> Set<T>`	`createSet()`
`static <T> Set<T>`	`createSet(Collection<T> c)`
`static <T> Set<T>`	`createSet(int initialCapacity)`
`static <T> Set<T>`	`createSet(T... elements)`
`static <T> Set<T>`	`createSet(T element)`
`static <T> List<T>`	`createSyncList()`
`static <K,V> ConcurrentHashMap<K,V>`	`createSyncMap()`
`static <T> Set<T>`	`createSyncSet()`
`static <K,V> Map<K,WeakReference<V>>`	`createSyncWeakMap()`
`static <T> Set<T>`	`getCopyOnRequestSet(Collection<T> source)`
`static <T> Set<T>`	`getCopyOnRequestSetFromImmutableCollection(Collection<T> source)`
`static <T> Set<T>`	`getCopyOnRequestSetFromMutableCollection(Collection<T> source)`
`static int`	`getExpectedThreads()`
`static <T> List<T>`	`list(Iterable<T> i)`
`static <T> List<T>`	`list(T... i)`
`static <T> List<T>`	`list(T i)`
`static void`	`setExpectedThreads(int value)`
`static <T extends OWLObject> List<T>`	`sortOptionally(Collection<T> toReturn)` Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionally(List<? extends T> toReturn, Class<T> desiredType)` Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionally(List<T> toReturn)` Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionally(java.util.stream.Stream<? extends T> toReturn, Class<T> desiredType)` Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionally(java.util.stream.Stream<T> toReturn)` Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionallyComparables(Collection<T> toReturn)` Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.
`static <T extends OWLObject> List<T>`	`sortOptionallyComparables(List<T> toReturn)` Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted.

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

- Method Detail
  - sortOptionallyComparables
```
public static <T extends OWLObject> List<T> sortOptionallyComparables(List<T> toReturn)
```
    Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Type Parameters:
    
    T - list type
    
    Parameters:
    
    toReturn - list to sort
    
    Returns:
    
    sorted input, if no errors are raised. Original otherwise.
  - sortOptionally
```
public static <T extends OWLObject> List<T> sortOptionally(List<T> toReturn)
```
    Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Parameters:
    
    toReturn - list to sort
    
    Returns:
    
    sorted input list
  - sortOptionally
```
public static <T extends OWLObject> List<T> sortOptionally(List<? extends T> toReturn,
                                                           Class<T> desiredType)
```
    Sort the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Parameters:
    
    toReturn - list to sort
    
    desiredType - witness for return type
    
    Returns:
    
    sorted input list
  - sortOptionallyComparables
```
public static <T extends OWLObject> List<T> sortOptionallyComparables(Collection<T> toReturn)
```
    Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Type Parameters:
    
    T - list type
    
    Parameters:
    
    toReturn - collection to sort
    
    Returns:
    
    sorted copy of the input, if no errors are raised. Copy of the original otherwise.
  - sortOptionally
```
public static <T extends OWLObject> List<T> sortOptionally(Collection<T> toReturn)
```
    Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Type Parameters:
    
    T - list type
    
    Parameters:
    
    toReturn - collection to sort
    
    Returns:
    
    sorted copy of the input, if no errors are raised. Copy of the original otherwise.
  - sortOptionally
```
public static <T extends OWLObject> List<T> sortOptionally(java.util.stream.Stream<T> toReturn)
```
    Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Type Parameters:
    
    T - list type
    
    Parameters:
    
    toReturn - collection to sort
    
    Returns:
    
    sorted copy of the input, if no errors are raised. Copy of the original otherwise.
  - sortOptionally
```
public static <T extends OWLObject> List<T> sortOptionally(java.util.stream.Stream<? extends T> toReturn,
                                                           Class<T> desiredType)
```
    Sort a copy of the input collection; if the ordering is unstable and an error is thrown (due to the use of TimSort in JDK 1.7 and newer), catch it and leave the collection unsorted. NOTE: use this method if ordering is desirable but not necessary.
    
    Type Parameters:
    
    T - list type
    
    Parameters:
    
    toReturn - collection to sort
    
    desiredType - witness for return type
    
    Returns:
    
    sorted copy of the input, if no errors are raised. Copy of the original otherwise.
  - setExpectedThreads
```
public static void setExpectedThreads(int value)
```
    Parameters:
    
    value - the number of expected threads that will access threadsafe collections; useful for increasing the concurrency in ConcurrentHashMaps
  - getExpectedThreads
```
public static int getExpectedThreads()
```
    Returns:
    
    The current number of expected threads.
  - createSet
```
public static <T> Set<T> createSet()
```
    Type Parameters:
    
    T - axiom type
    
    Returns:
    
    fresh non threadsafe set
  - createLinkedSet
```
public static <T> Set<T> createLinkedSet()
```
    Type Parameters:
    
    T - axiom type
    
    Returns:
    
    fresh non threadsafe set
  - createList
```
public static <T> List<T> createList()
```
    Type Parameters:
    
    T - axiom type
    
    Returns:
    
    fresh non threadsafe list
  - createList
```
@SafeVarargs
public static <T> List<T> createList(T... elements)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    elements - values to add to the list
    
    Returns:
    
    fresh non threadsafe list
  - createSyncList
```
public static <T> List<T> createSyncList()
```
    Type Parameters:
    
    T - content type
    
    Returns:
    
    fresh threadsafe list
  - list
```
public static <T> List<T> list(Iterable<T> i)
```
    Type Parameters:
    
    T - type
    
    Parameters:
    
    i - iterable
    
    Returns:
    
    list from iterable
  - list
```
@SafeVarargs
public static <T> List<T> list(T... i)
```
    Type Parameters:
    
    T - type
    
    Parameters:
    
    i - iterable
    
    Returns:
    
    list from iterable
  - list
```
public static <T> List<T> list(T i)
```
    Type Parameters:
    
    T - type
    
    Parameters:
    
    i - iterable
    
    Returns:
    
    list from iterable
  - createSet
```
public static <T> Set<T> createSet(Collection<T> c)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    c - values to add to the set
    
    Returns:
    
    fresh non threadsafe set
  - createSet
```
public static <T> Set<T> createSet(int initialCapacity)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    initialCapacity - initial capacity for the new set
    
    Returns:
    
    fresh non threadsafe set
  - createMap
```
public static <K,V> Map<K,V> createMap()
```
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    fresh map
  - createSyncWeakMap
```
public static <K,V> Map<K,WeakReference<V>> createSyncWeakMap()
```
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    a new weak hashmap wrapped as a synchronized map
  - createSet
```
@SafeVarargs
public static <T> Set<T> createSet(T... elements)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    elements - values to add to the set
    
    Returns:
    
    fresh non threadsafe set
  - createSet
```
public static <T> Set<T> createSet(T element)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    element - value to add to the set
    
    Returns:
    
    fresh non threadsafe set
  - createSyncSet
```
public static <T> Set<T> createSyncSet()
```
    Type Parameters:
    
    T - set type
    
    Returns:
    
    fresh threadsafe set
  - createSyncMap
```
public static <K,V> ConcurrentHashMap<K,V> createSyncMap()
```
    Type Parameters:
    
    K - key type
    
    V - value type
    
    Returns:
    
    fresh threadsafe hashmap
  - getCopyOnRequestSet
```
public static <T> Set<T> getCopyOnRequestSet(Collection<T> source)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    source - the collection to lazily copy
    
    Returns:
    
    a lazy defensive copy for source; the source collection will not be copied until a method that modifies the collection gets called, e.g., add(), addAll()
  - getCopyOnRequestSetFromMutableCollection
```
public static <T> Set<T> getCopyOnRequestSetFromMutableCollection(@Nullable
                                                                  Collection<T> source)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    source - source collection
    
    Returns:
    
    copy on request that builds a list from the input set
  - copy
```
public static <T> Set<T> copy(@Nullable
                              Collection<T> source)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    source - the source collection, expected to be immutable
    
    Returns:
    
    copy on request that does not build a list immediately
  - copyMutable
```
public static <T> Set<T> copyMutable(@Nullable
                                     Collection<T> source)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    source - the source collection, expected to be mutable; the backing list is created immediately
    
    Returns:
    
    copy on request that builds a list immediately
  - getCopyOnRequestSetFromImmutableCollection
```
public static <T> Set<T> getCopyOnRequestSetFromImmutableCollection(@Nullable
                                                                    Collection<T> source)
```
    Type Parameters:
    
    T - axiom type
    
    Parameters:
    
    source - the source collection, expected to be immutable
    
    Returns:
    
    copy on request that does not build a list immediately

Class CollectionFactory

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

sortOptionallyComparables

sortOptionally

sortOptionally

sortOptionallyComparables

sortOptionally

sortOptionally

sortOptionally

setExpectedThreads

getExpectedThreads

createSet

createLinkedSet

createList

createList

createSyncList

list

list

list

createSet

createSet

createMap

createSyncWeakMap

createSet

createSet

createSyncSet

createSyncMap

getCopyOnRequestSet

getCopyOnRequestSetFromMutableCollection

copy

copyMutable

getCopyOnRequestSetFromImmutableCollection