IxHelperFunctions (ixjava 0.92.6 API)

java.lang.Object
- ix.internal.util.IxHelperFunctions

public final class IxHelperFunctions
extends java.lang.Object

Helper class with function types.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static <T> rx.functions.Func0<java.util.ArrayList<T>>`	`arrayListProvider()` A list creator factory.
`static <T,U> rx.functions.Func1<U,java.util.ArrayList<T>>`	`arrayListProvider1()` A list creator factory for Func1 that ignores the parameter.
`static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T>`	`comparator()` Returns a convenience comparator which basically compares objects which implement the `Comparable` interface.
`static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T>`	`comparator0()` Returns a convenience comparator which basically compares objects which implement the `Comparable` interface.
`static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T>`	`comparatorReverse()` Creates a new comparator which reverses the order of the comparison.
`static <T> java.util.Comparator<T>`	`comparatorReverse(java.util.Comparator<? super T> normal)` Creates a new comparator which reverses the order produced by the given normal comparator.
`static <K,V> rx.functions.Func0<java.util.concurrent.ConcurrentHashMap<K,V>>`	`concurrentHashMapProvider()` A map creator factory.
`static <Param1,Result> rx.functions.Func1<Param1,Result>`	`constant(Result value)` Creates a function which returns always the same value.
`static <T> rx.functions.Func0<T>`	`constant0(T value)` Creates a function which returns always the same value.
`static <K,V> rx.functions.Func0<java.util.HashMap<K,V>>`	`hashMapProvider()` A map creator factory.
`static <T> rx.functions.Func0<java.util.HashSet<T>>`	`hashSetProvider()` A set creation provider.
`static <T> rx.functions.Func1<T,T>`	`identity()`
`static <T,U> rx.functions.Func2<T,U,T>`	`identityFirst()` Returns a helper function of two parameters which always returns its first parameter.
`static <T,U> rx.functions.Func2<T,U,U>`	`identitySecond()` Returns a helper function of two parameters which always returns its second parameter.
`static <K,V> rx.functions.Func0<java.util.LinkedHashMap<K,V>>`	`linkedHashMapProvider()` A map creator factory.
`static <T> rx.functions.Func0<java.util.LinkedList<T>>`	`linkedListProvider()` A list creator factory.
`static <T extends java.lang.Comparable<? super T>> rx.functions.Func2<T,T,T>`	`max()` Returns a function which returns the greater of its parameters.
`static <T> rx.functions.Func2<T,T,T>`	`max(java.util.Comparator<? super T> comparator)` Returns a function which returns the greater of its parameters in respect to the supplied `Comparator`.
`static <T extends java.lang.Comparable<? super T>> rx.functions.Func2<T,T,T>`	`min()` Returns a function which returns the smaller of its parameters.
`static <T> rx.functions.Func2<T,T,T>`	`min(java.util.Comparator<? super T> comparator)` Returns a function which returns the smaller of its parameters in respect to the supplied `Comparator`.
`static rx.functions.Func1<java.lang.Boolean,java.lang.Boolean>`	`negate()`
`static rx.functions.Func2<java.math.BigDecimal,java.math.BigDecimal,java.math.BigDecimal>`	`sumBigDecimal()` Retuns a function that adds two BigDecimal numbers and returns a new one.
`static rx.functions.Func2<java.math.BigInteger,java.math.BigInteger,java.math.BigInteger>`	`sumBigInteger()` Retuns a function that adds two BigInteger numbers and returns a new one.
`static rx.functions.Func2<java.lang.Double,java.lang.Double,java.lang.Double>`	`sumDouble()` Retuns a function that adds two Double number and returns a new one.
`static rx.functions.Func2<java.lang.Float,java.lang.Float,java.lang.Float>`	`sumFloat()` Retuns a function that adds two Float number and returns a new one.
`static rx.functions.Func2<java.lang.Integer,java.lang.Integer,java.lang.Integer>`	`sumInteger()` Retuns a function that adds two Integer number and returns a new one.
`static rx.functions.Func2<java.lang.Long,java.lang.Long,java.lang.Long>`	`sumLong()` Retuns a function that adds two Long number and returns a new one.
`static <K,V> rx.functions.Func0<java.util.TreeMap<K,V>>`	`treeMapProvider()` A map creator factory.
`static <K,V> rx.functions.Func0<java.util.TreeMap<K,V>>`	`treeMapProvider(java.util.Comparator<? super K> keyComparator)` A map creator factory.
`static <T> rx.functions.Func0<java.util.TreeSet<T>>`	`treeSetProvider()` A set creation provider.
`static <T> rx.functions.Func0<java.util.TreeSet<T>>`	`treeSetProvider(java.util.Comparator<? super T> elementComparator)` A set creation provider.

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

- Method Detail
  - constant
```
public static <Param1,Result> rx.functions.Func1<Param1,Result> constant(Result value)
```
    Creates a function which returns always the same value.
    
    Type Parameters:
    
    Param1 - the parameter type, irrelevant
    
    Result - the value type to return
    
    Parameters:
    
    value - the value to return
    
    Returns:
    
    the function
  - constant0
```
public static <T> rx.functions.Func0<T> constant0(T value)
```
    Creates a function which returns always the same value.
    
    Type Parameters:
    
    T - the value type to return
    
    Parameters:
    
    value - the value to return
    
    Returns:
    
    the function
  - max
```
public static <T extends java.lang.Comparable<? super T>> rx.functions.Func2<T,T,T> max()
```
    Returns a function which returns the greater of its parameters. If only one of the parameters is null, the other parameter is returned. If both parameters are null, null is returned.
    
    Type Parameters:
    
    T - the parameter types, which must be self-comparable
    
    Returns:
    
    the function
  - min
```
public static <T extends java.lang.Comparable<? super T>> rx.functions.Func2<T,T,T> min()
```
    Returns a function which returns the smaller of its parameters. If only one of the parameters is null, the other parameter is returned. If both parameters are null, null is returned.
    
    Type Parameters:
    
    T - the parameter types, which must be self-comparable
    
    Returns:
    
    the function
  - identityFirst
```
public static <T,U> rx.functions.Func2<T,U,T> identityFirst()
```
    Returns a helper function of two parameters which always returns its first parameter.
    
    Type Parameters:
    
    T - the result and the first parameter type
    
    U - the second parameter type, irrelevant
    
    Returns:
    
    the function
  - identitySecond
```
public static <T,U> rx.functions.Func2<T,U,U> identitySecond()
```
    Returns a helper function of two parameters which always returns its second parameter.
    
    Type Parameters:
    
    T - the result and the second parameter type
    
    U - the first parameter type, irrelevant
    
    Returns:
    
    the function
  - max
```
public static <T> rx.functions.Func2<T,T,T> max(java.util.Comparator<? super T> comparator)
```
    Returns a function which returns the greater of its parameters in respect to the supplied Comparator. If only one of the parameters is null, the other parameter is returned. If both parameters are null, null is returned.
    
    Type Parameters:
    
    T - the parameter types, which must be self-comparable
    
    Parameters:
    
    comparator - the value comparator
    
    Returns:
    
    the function
  - min
```
public static <T> rx.functions.Func2<T,T,T> min(java.util.Comparator<? super T> comparator)
```
    Returns a function which returns the smaller of its parameters in respect to the supplied Comparator. If only one of the parameters is null, the other parameter is returned. If both parameters are null, null is returned.
    
    Type Parameters:
    
    T - the parameter types, which must be self-comparable
    
    Parameters:
    
    comparator - the value comparator
    
    Returns:
    
    the function
  - comparator
```
public static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T> comparator()
```
    Returns a convenience comparator which basically compares objects which implement the Comparable interface. The comparator is null safe in the manner, that nulls are always less than any non-nulls. To have a comparator which places nulls last, use the comparator0() method.
    
    Type Parameters:
    
    T - the element types to compare
    
    Returns:
    
    the comparator
    
    See Also:
    
    comparator0()
  - comparator0
```
public static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T> comparator0()
```
    Returns a convenience comparator which basically compares objects which implement the Comparable interface. The comparator is null safe in the manner, that nulls are always greater than any non-nulls. To have a comparator which places nulls first, use the comparator() method.
    
    Type Parameters:
    
    T - the element types to compare
    
    Returns:
    
    the comparator
  - comparatorReverse
```
public static <T extends java.lang.Comparable<? super T>> java.util.Comparator<T> comparatorReverse()
```
    Creates a new comparator which reverses the order of the comparison.
    
    Type Parameters:
    
    T - the element type, which must be self comparable
    
    Returns:
    
    the new comparator
  - comparatorReverse
```
public static <T> java.util.Comparator<T> comparatorReverse(java.util.Comparator<? super T> normal)
```
    Creates a new comparator which reverses the order produced by the given normal comparator.
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    normal - the normal comparator
    
    Returns:
    
    the new comparator
  - sumBigDecimal
```
public static rx.functions.Func2<java.math.BigDecimal,java.math.BigDecimal,java.math.BigDecimal> sumBigDecimal()
```
    Retuns a function that adds two BigDecimal numbers and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - sumBigInteger
```
public static rx.functions.Func2<java.math.BigInteger,java.math.BigInteger,java.math.BigInteger> sumBigInteger()
```
    Retuns a function that adds two BigInteger numbers and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - sumDouble
```
public static rx.functions.Func2<java.lang.Double,java.lang.Double,java.lang.Double> sumDouble()
```
    Retuns a function that adds two Double number and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - sumFloat
```
public static rx.functions.Func2<java.lang.Float,java.lang.Float,java.lang.Float> sumFloat()
```
    Retuns a function that adds two Float number and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - sumInteger
```
public static rx.functions.Func2<java.lang.Integer,java.lang.Integer,java.lang.Integer> sumInteger()
```
    Retuns a function that adds two Integer number and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - sumLong
```
public static rx.functions.Func2<java.lang.Long,java.lang.Long,java.lang.Long> sumLong()
```
    Retuns a function that adds two Long number and returns a new one.
    If the first parameter is null, it returns the second parameter.
    
    Returns:
    
    Function to sum integers in aggregators.
  - arrayListProvider
```
public static <T> rx.functions.Func0<java.util.ArrayList<T>> arrayListProvider()
```
    A list creator factory.
    
    Type Parameters:
    
    T - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete list implementation.
  - arrayListProvider1
```
public static <T,U> rx.functions.Func1<U,java.util.ArrayList<T>> arrayListProvider1()
```
    A list creator factory for Func1 that ignores the parameter.
    
    Type Parameters:
    
    T - the value type
    
    U - the function parameter type, ignored
    
    Returns:
    
    a function which creates a new empty instance of the given concrete list implementation.
  - linkedListProvider
```
public static <T> rx.functions.Func0<java.util.LinkedList<T>> linkedListProvider()
```
    A list creator factory.
    
    Type Parameters:
    
    T - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete list implementation.
  - hashMapProvider
```
public static <K,V> rx.functions.Func0<java.util.HashMap<K,V>> hashMapProvider()
```
    A map creator factory.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete map implementation.
  - treeMapProvider
```
public static <K,V> rx.functions.Func0<java.util.TreeMap<K,V>> treeMapProvider()
```
    A map creator factory.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete map implementation.
  - treeMapProvider
```
public static <K,V> rx.functions.Func0<java.util.TreeMap<K,V>> treeMapProvider(java.util.Comparator<? super K> keyComparator)
```
    A map creator factory.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Parameters:
    
    keyComparator - the key comparator function
    
    Returns:
    
    a function which creates a new empty instance of the given concrete map implementation.
  - linkedHashMapProvider
```
public static <K,V> rx.functions.Func0<java.util.LinkedHashMap<K,V>> linkedHashMapProvider()
```
    A map creator factory.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete map implementation.
  - concurrentHashMapProvider
```
public static <K,V> rx.functions.Func0<java.util.concurrent.ConcurrentHashMap<K,V>> concurrentHashMapProvider()
```
    A map creator factory.
    
    Type Parameters:
    
    K - the key type
    
    V - the value type
    
    Returns:
    
    a function which creates a new empty instance of the given concrete map implementation.
  - hashSetProvider
```
public static <T> rx.functions.Func0<java.util.HashSet<T>> hashSetProvider()
```
    A set creation provider.
    
    Type Parameters:
    
    T - the element type
    
    Returns:
    
    the function which creates an empty instance of the set
  - treeSetProvider
```
public static <T> rx.functions.Func0<java.util.TreeSet<T>> treeSetProvider()
```
    A set creation provider.
    
    Type Parameters:
    
    T - the element type
    
    Returns:
    
    the function which creates an empty instance of the set
  - treeSetProvider
```
public static <T> rx.functions.Func0<java.util.TreeSet<T>> treeSetProvider(java.util.Comparator<? super T> elementComparator)
```
    A set creation provider.
    
    Type Parameters:
    
    T - the element type
    
    Parameters:
    
    elementComparator - the custom element comparator
    
    Returns:
    
    the function which creates an empty instance of the set
  - negate
```
public static rx.functions.Func1<java.lang.Boolean,java.lang.Boolean> negate()
```
    Returns:
    
    Returns a function that negates the incoming boolean value.
  - identity
```
public static <T> rx.functions.Func1<T,T> identity()
```
    Type Parameters:
    
    T - the input and result type
    
    Returns:
    
    a function which returns the single parameter value as its result.

Class IxHelperFunctions

Method Summary

Methods inherited from class java.lang.Object

Method Detail

constant

constant0

max

min

identityFirst

identitySecond

max

min

comparator

comparator0

comparatorReverse

comparatorReverse

sumBigDecimal

sumBigInteger

sumDouble

sumFloat

sumInteger

sumLong

arrayListProvider

arrayListProvider1

linkedListProvider

hashMapProvider

treeMapProvider

treeMapProvider

linkedHashMapProvider

concurrentHashMapProvider

hashSetProvider

treeSetProvider

treeSetProvider

negate

identity