CollectionUtils (java-utils 1.1.0 API)

java.lang.Object
- pl.jalokim.utils.collection.CollectionUtils

public final class CollectionUtils
extends Object

Some utils methods for collections.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> boolean`	`addWhenNotExist(Collection<T> list, T element)` It add to collection if is not present already.
`static <T> List<T>`	`filterToList(Collection<T> collection, Predicate<T> filter)` This method get some collection and filter expected elements and put them to new List.
`static <T,R> List<R>`	`filterToList(Collection<T> collection, Predicate<T> filter, Function<T,R> mapFunc)` This method get some collection and filter expected elements and map them to new type and put results to new List.
`static <T,R> List<R>`	`filterToList(Predicate<T> predicate, Function<T,R> mapFunc, T... array)` This method get some array and filter expected elements and map them to new type and put results to new List.
`static <T> List<T>`	`filterToList(Predicate<T> predicate, T... array)` This method get some collection and filter expected elements and put them to new List.
`static <T> Set<T>`	`filterToSet(Collection<T> collection, Predicate<T> filter)` This method get some collection and filter expected elements and put them to new set.
`static <T,R> Set<R>`	`filterToSet(Collection<T> collection, Predicate<T> filter, Function<T,R> mapFunc)` This method get some collection and filter expected elements and map them to new type and put results to new Set.
`static <T> T`	`getFirst(List<T> list)` It returns first element from list if present.
`static <T> T`	`getLast(List<T> list)` It returns last element from list if present.
`static int`	`getLastIndex(Collection<?> list)` It returns last index from list.
`static int`	`getLastIndex(Object... array)` It returns last index from array.
`static <T extends Comparable<? super T>> boolean`	`hasTheSameElements(Collection<T> first, Collection<T> second)` It return true when provided collections have the same elements.
`static <E> List<E>`	`intersection(Collection<E> first, Collection<E> second)` It return intersection for two given collections.
`static <T> boolean`	`isEmpty(Collection<T> list)` It returns true when collection is null or empty.
`static boolean`	`isLastIndex(List<?> list, int index)` check that given index is last in certain list.
`static boolean`	`isLastIndex(Object[] array, int index)` check that given index is last in certain array.
`static <T> boolean`	`isNotEmpty(Collection<T> list)` It returns true only when collection is not null, and if not empty.
`static <T,R> List<R>`	`mapToList(Collection<T> collection, Function<T,R> mapFunc)` This method return new List with mapped values from source collection.
`static <T,R> List<R>`	`mapToList(Collection<T> collection, Function<T,R> mapFunc, Predicate<R> filter)` This method return new List with mapped values from source collection.
`static <T,R> List<R>`	`mapToList(Function<T,R> mapFunc, Predicate<R> predicate, T... array)` This method return new List with mapped values from source array.
`static <T,R> List<R>`	`mapToList(Function<T,R> mapFunc, T... array)` This method return new List with mapped values from source array.
`static <T,R> Set<R>`	`mapToSet(Collection<T> collection, Function<T,R> mapFunc)` This method return new Set with mapped values from source collection.
`static <T,R> Set<R>`	`mapToSet(Collection<T> collection, Function<T,R> mapFunc, Predicate<R> filter)` This method return new Set with mapped values from source collection.
`static <T extends Comparable<? super T>> List<T>`	`sortAsNewList(Collection<T> list)` It get list and sort elements but not change source list.
`static <T> List<T>`	`swapElementsAsNewList(List<T> sourceList, int indexToSwap, T newValue)` Swap element in copy of sourceList and returns it.

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

- Method Detail
  - isLastIndex
```
public static boolean isLastIndex(List<?> list,
                                  int index)
```
    check that given index is last in certain list.
    
    Parameters:
    
    list - list to check.
    
    index - index to check
    
    Returns:
    
    boolean value.
  - isLastIndex
```
public static boolean isLastIndex(Object[] array,
                                  int index)
```
    check that given index is last in certain array.
    
    Parameters:
    
    array - list to check.
    
    index - index to check
    
    Returns:
    
    boolean value.
  - getLastIndex
```
public static int getLastIndex(Collection<?> list)
```
    It returns last index from list.
    
    Parameters:
    
    list - for get last index.
    
    Returns:
    
    last index for certain list.
  - getLastIndex
```
public static int getLastIndex(Object... array)
```
    It returns last index from array.
    
    Parameters:
    
    array - for get last index.
    
    Returns:
    
    last index for certain array.
  - filterToSet
```
public static <T> Set<T> filterToSet(Collection<T> collection,
                                     Predicate<T> filter)
```
    This method get some collection and filter expected elements and put them to new set.
    
    Type Parameters:
    
    T - generic type for collection and predicate.
    
    Parameters:
    
    collection - source collection.
    
    filter - predicate for filter.
    
    Returns:
    
    new Set of filtered element from source collection.
  - filterToSet
```
public static <T,R> Set<R> filterToSet(Collection<T> collection,
                                       Predicate<T> filter,
                                       Function<T,R> mapFunc)
```
    This method get some collection and filter expected elements and map them to new type and put results to new Set.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result Set.
    
    Parameters:
    
    collection - source collection.
    
    filter - predicate for filter by source elements type.
    
    mapFunc - map to new type filtered result.
    
    Returns:
    
    Set with filtered source and another types than source collection.
  - mapToSet
```
public static <T,R> Set<R> mapToSet(Collection<T> collection,
                                    Function<T,R> mapFunc)
```
    This method return new Set with mapped values from source collection.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result Set.
    
    Parameters:
    
    collection - source elements.
    
    mapFunc - function for map from collection to new Set with another types.
    
    Returns:
    
    new Set with another type elements than source elements type.
  - mapToSet
```
public static <T,R> Set<R> mapToSet(Collection<T> collection,
                                    Function<T,R> mapFunc,
                                    Predicate<R> filter)
```
    This method return new Set with mapped values from source collection. But after map it can filter them by last method argument.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result Set.
    
    Parameters:
    
    collection - source elements.
    
    mapFunc - function for map from collection to new Set with another types.
    
    filter - predicate for mapped elements.
    
    Returns:
    
    set with another type of filtered elements than from source.
  - mapToList
```
public static <T,R> List<R> mapToList(Collection<T> collection,
                                      Function<T,R> mapFunc)
```
    This method return new List with mapped values from source collection.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result List.
    
    Parameters:
    
    collection - source elements.
    
    mapFunc - function for map from collection to new List with another types.
    
    Returns:
    
    new List with another type elements than source elements type.
  - mapToList
```
public static <T,R> List<R> mapToList(Collection<T> collection,
                                      Function<T,R> mapFunc,
                                      Predicate<R> filter)
```
    This method return new List with mapped values from source collection. But after map it can filter them by last method argument.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result List.
    
    Parameters:
    
    collection - source elements.
    
    mapFunc - function for map from collection to new List with another types.
    
    filter - predicate for mapped elements.
    
    Returns:
    
    new List with another type of filtered elements than source elements type.
  - mapToList
```
public static <T,R> List<R> mapToList(Function<T,R> mapFunc,
                                      T... array)
```
    This method return new List with mapped values from source array.
    
    Type Parameters:
    
    T - type for source array.
    
    R - type for result List.
    
    Parameters:
    
    mapFunc - function for map from collection to new List with another types.
    
    array - source elements.
    
    Returns:
    
    new List with another type elements than source elements type.
  - mapToList
```
public static <T,R> List<R> mapToList(Function<T,R> mapFunc,
                                      Predicate<R> predicate,
                                      T... array)
```
    This method return new List with mapped values from source array. But after map it can filter them by second method argument.
    
    Type Parameters:
    
    T - type for source array.
    
    R - type for result List.
    
    Parameters:
    
    mapFunc - function for map from collection to new List with another types.
    
    predicate - predicate for filter.
    
    array - source elements.
    
    Returns:
    
    new List with another type elements than source elements type.
  - filterToList
```
public static <T> List<T> filterToList(Collection<T> collection,
                                       Predicate<T> filter)
```
    This method get some collection and filter expected elements and put them to new List.
    
    Type Parameters:
    
    T - generic type for collection and predicate.
    
    Parameters:
    
    collection - source collection.
    
    filter - predicate for filter.
    
    Returns:
    
    new List of filtered element from source collection.
  - filterToList
```
public static <T,R> List<R> filterToList(Collection<T> collection,
                                         Predicate<T> filter,
                                         Function<T,R> mapFunc)
```
    This method get some collection and filter expected elements and map them to new type and put results to new List.
    
    Type Parameters:
    
    T - type for source collection.
    
    R - type for result List.
    
    Parameters:
    
    collection - source collection.
    
    filter - predicate for filter by source elements type.
    
    mapFunc - map to new type filtered result.
    
    Returns:
    
    new List with filtered source and another types than source collection.
  - filterToList
```
public static <T> List<T> filterToList(Predicate<T> predicate,
                                       T... array)
```
    This method get some collection and filter expected elements and put them to new List.
    
    Type Parameters:
    
    T - generic type for collection and predicate.
    
    Parameters:
    
    predicate - predicate for filter.
    
    array - source collection.
    
    Returns:
    
    new List of filtered element from source array.
  - filterToList
```
public static <T,R> List<R> filterToList(Predicate<T> predicate,
                                         Function<T,R> mapFunc,
                                         T... array)
```
    This method get some array and filter expected elements and map them to new type and put results to new List.
    
    Type Parameters:
    
    T - type for source array.
    
    R - type for result List.
    
    Parameters:
    
    predicate - predicate for filter by source elements type.
    
    mapFunc - map to new type filtered result.
    
    array - source array.
    
    Returns:
    
    new List with filtered source and another types than source array.
  - sortAsNewList
```
public static <T extends Comparable<? super T>> List<T> sortAsNewList(Collection<T> list)
```
    It get list and sort elements but not change source list.
    
    Type Parameters:
    
    T - generic type in list.
    
    Parameters:
    
    list - to sort.
    
    Returns:
    
    returns copy of source list but with sorted values.
  - swapElementsAsNewList
```
public static <T> List<T> swapElementsAsNewList(List<T> sourceList,
                                                int indexToSwap,
                                                T newValue)
```
    Swap element in copy of sourceList and returns it.
    
    Type Parameters:
    
    T - generic type for list.
    
    Parameters:
    
    sourceList - source for swap.
    
    indexToSwap - index element to swap in copy of source list
    
    newValue - new value in certain index.
    
    Returns:
    
    copy of source list with swapped value.
  - getFirst
```
public static <T> T getFirst(List<T> list)
```
    It returns first element from list if present.
    
    Type Parameters:
    
    T - generic type
    
    Parameters:
    
    list - as source
    
    Returns:
    
    returns first element if present.
  - getLast
```
public static <T> T getLast(List<T> list)
```
    It returns last element from list if present.
    
    Type Parameters:
    
    T - generic type
    
    Parameters:
    
    list - as source
    
    Returns:
    
    returns last element if present.
  - addWhenNotExist
```
public static <T> boolean addWhenNotExist(Collection<T> list,
                                          T element)
```
    It add to collection if is not present already.
    
    Type Parameters:
    
    T - generic type of collection and tried add element.
    
    Parameters:
    
    list - where will be added element.
    
    element - to add.
    
    Returns:
    
    return true when element was added.
  - hasTheSameElements
```
public static <T extends Comparable<? super T>> boolean hasTheSameElements(Collection<T> first,
                                                                           Collection<T> second)
```
    It return true when provided collections have the same elements. Order or elements is not important here.
    
    Type Parameters:
    
    T - generic type of collections.
    
    Parameters:
    
    first - collection
    
    second - collection
    
    Returns:
    
    true when has the same elements.
  - isEmpty
```
public static <T> boolean isEmpty(Collection<T> list)
```
    It returns true when collection is null or empty.
    
    Type Parameters:
    
    T - generic type.
    
    Parameters:
    
    list - to verify.
    
    Returns:
    
    boolean value.
  - isNotEmpty
```
public static <T> boolean isNotEmpty(Collection<T> list)
```
    It returns true only when collection is not null, and if not empty.
    
    Type Parameters:
    
    T - generic type.
    
    Parameters:
    
    list - to verify.
    
    Returns:
    
    boolean value.
  - intersection
```
public static <E> List<E> intersection(Collection<E> first,
                                       Collection<E> second)
```
    It return intersection for two given collections.
    
    Type Parameters:
    
    E - generic type.
    
    Parameters:
    
    first - collection.
    
    second - collection.
    
    Returns:
    
    return intersected elements.

Class CollectionUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

isLastIndex

isLastIndex

getLastIndex

getLastIndex

filterToSet

filterToSet

mapToSet

mapToSet

mapToList

mapToList

mapToList

mapToList

filterToList

filterToList

filterToList

filterToList

sortAsNewList

swapElementsAsNewList

getFirst

getLast

addWhenNotExist

hasTheSameElements

isEmpty

isNotEmpty

intersection