com.gs.collections.impl.block.factory

Class Functions

java.lang.Object

com.gs.collections.impl.block.factory.Functions

public final class Functions
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Functions.BooleanFunctionChain<T1,T2>
static class	Functions.ByteFunctionChain<T1,T2>
static class	Functions.CharFunctionChain<T1,T2>
static class	Functions.DoubleFunctionChain<T1,T2>
static class	Functions.FloatFunctionChain<T1,T2>
static class	Functions.FunctionChain<T1,T2,T3>
static class	Functions.IntFunctionChain<T1,T2>
static class	Functions.LongFunctionChain<T1,T2>
static class	Functions.ShortFunctionChain<T1,T2>
static class	Functions.SizeFunction

Method Summary

Methods

Modifier and Type	Method and Description
static <T,P,R> com.gs.collections.api.block.function.Function<T,R>	bind(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends R> function, P parameter) Bind the parameter passed to a Function2 into a new Function.
static <T1,T2> com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<T1>	bind(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T2> delegate, com.gs.collections.api.block.function.Function<? super T1,T2> function) Bind the input of a ObjectIntProcedure to the result of an function, returning a new ObjectIntProcedure.
static <T1,T2> com.gs.collections.api.block.procedure.Procedure<T1>	bind(com.gs.collections.api.block.procedure.Procedure<? super T2> delegate, com.gs.collections.api.block.function.Function<? super T1,T2> function) Bind the input of a Procedure to the result of an function, returning a new Procedure.
static <T1,T2,T3> com.gs.collections.api.block.procedure.Procedure2<T1,T3>	bind(com.gs.collections.api.block.procedure.Procedure2<? super T2,T3> delegate, com.gs.collections.api.block.function.Function<? super T1,T2> function) Bind the input of the first argument of a Procedure2 to the result of an function, returning a new Procedure2.
static <T extends java.lang.Comparable<? super T>,V> CaseFunction<T,V>	caseDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> defaultFunction)
static <T extends java.lang.Comparable<? super T>,V> CaseFunction<T,V>	caseDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> defaultFunction, com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T1,T2,T3> Functions.FunctionChain<T1,T2,T3>	chain(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.Function<? super T2,T3> function2)
static <T1,T2> Functions.BooleanFunctionChain<T1,T2>	chainBoolean(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.BooleanFunction<? super T2> function2)
static <T1,T2> Functions.ByteFunctionChain<T1,T2>	chainByte(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.ByteFunction<? super T2> function2)
static <T1,T2> Functions.CharFunctionChain<T1,T2>	chainChar(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.CharFunction<? super T2> function2)
static <T1,T2> Functions.DoubleFunctionChain<T1,T2>	chainDouble(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.DoubleFunction<? super T2> function2)
static <T1,T2> Functions.FloatFunctionChain<T1,T2>	chainFloat(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.FloatFunction<? super T2> function2)
static <T1,T2> Functions.IntFunctionChain<T1,T2>	chainInt(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.IntFunction<? super T2> function2)
static <T1,T2> Functions.LongFunctionChain<T1,T2>	chainLong(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.LongFunction<? super T2> function2)
static <T1,T2> Functions.ShortFunctionChain<T1,T2>	chainShort(com.gs.collections.api.block.function.Function<T1,T2> function1, com.gs.collections.api.block.function.primitive.ShortFunction<? super T2> function2)
static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.Class<?>>	classForName()
static <T1,T2,I extends java.lang.Iterable<T2>> com.gs.collections.api.block.function.Function<T1,I>	firstNotEmptyCollectionValue(com.gs.collections.api.block.function.Function<T1,I>... functions)
static <T> com.gs.collections.api.block.function.Function<T,java.lang.String>	firstNotEmptyStringValue(com.gs.collections.api.block.function.Function<T,java.lang.String>... functions)
static <T,V> com.gs.collections.api.block.function.Function<T,V>	firstNotNullValue(com.gs.collections.api.block.function.Function<T,V>... functions)
static <V1> com.gs.collections.api.block.function.Function<com.gs.collections.api.tuple.Pair<V1,?>,V1>	firstOfPair()
static com.gs.collections.api.block.function.Function<java.lang.Double,java.lang.Double>	getDoublePassThru()
static <T,V> com.gs.collections.api.block.function.Function<T,V>	getFixedValue(V value)
static com.gs.collections.api.block.function.Function<java.lang.Integer,java.lang.Integer>	getIntegerPassThru()
static <K> com.gs.collections.api.block.function.Function<java.util.Map.Entry<K,?>,K>	getKeyFunction()
static com.gs.collections.api.block.function.Function<java.lang.Long,java.lang.Long>	getLongPassThru()
static com.gs.collections.api.block.function.Function<java.lang.Number,java.lang.Double>	getMathSinFunction()
static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.String>	getNullSafeToString(java.lang.String defaultValue)
static com.gs.collections.api.block.function.Function<java.lang.Number,java.lang.Number>	getNumberPassThru()
static <T> com.gs.collections.api.block.function.Function<T,T>	getPassThru()
static com.gs.collections.api.block.function.Function<java.lang.Iterable<?>,java.lang.Integer>	getSizeOf()
static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.String>	getStringPassThru()
static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.Integer>	getStringToInteger()
static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.String>	getStringTrim()
static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.Class<?>>	getToClass()
static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.String>	getToString()
static <V> com.gs.collections.api.block.function.Function<java.util.Map.Entry<?,V>,V>	getValueFunction()
static <T,V> com.gs.collections.api.block.function.Function<T,V>	ifElse(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> trueFunction, com.gs.collections.api.block.function.Function<? super T,? extends V> falseFunction)
static <T,V> com.gs.collections.api.block.function.Function<T,V>	ifTrue(com.gs.collections.api.block.predicate.Predicate<? super T> predicate, com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T,V> com.gs.collections.api.block.function.Function<T,V>	nullSafe(com.gs.collections.api.block.function.Function<? super T,? extends V> function)
static <T,V> com.gs.collections.api.block.function.Function<T,V>	nullSafe(com.gs.collections.api.block.function.Function<? super T,? extends V> function, V nullValue)
static <T,V1,V2> com.gs.collections.api.block.function.Function<T,com.gs.collections.api.tuple.Pair<V1,V2>>	pair(com.gs.collections.api.block.function.Function<T,V1> function1, com.gs.collections.api.block.function.Function<T,V2> function2)
static <V2> com.gs.collections.api.block.function.Function<com.gs.collections.api.tuple.Pair<?,V2>,V2>	secondOfPair()
static com.gs.collections.api.block.function.Function<java.lang.Integer,java.lang.Integer>	squaredInteger()
static <T,V> com.gs.collections.api.block.function.Function<T,V>	synchronizedEach(com.gs.collections.api.block.function.Function<T,V> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toBooleanComparator(com.gs.collections.api.block.function.primitive.BooleanFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toByteComparator(com.gs.collections.api.block.function.primitive.ByteFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toCharComparator(com.gs.collections.api.block.function.primitive.CharFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toDoubleComparator(com.gs.collections.api.block.function.primitive.DoubleFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toFloatComparator(com.gs.collections.api.block.function.primitive.FloatFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toIntComparator(com.gs.collections.api.block.function.primitive.IntFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toLongComparator(com.gs.collections.api.block.function.primitive.LongFunction<T> function)
static <T> com.gs.collections.api.block.SerializableComparator<T>	toShortComparator(com.gs.collections.api.block.function.primitive.ShortFunction<T> function)
static <T,V> com.gs.collections.api.block.function.Function<T,V>	withDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> function, V defaultValue)

Methods inherited from class java.lang.Object

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

Method Detail

getPassThru

public static <T> com.gs.collections.api.block.function.Function<T,T> getPassThru()

getFixedValue

public static <T,V> com.gs.collections.api.block.function.Function<T,V> getFixedValue(V value)

getToClass

public static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.Class<?>> getToClass()

getMathSinFunction

public static com.gs.collections.api.block.function.Function<java.lang.Number,java.lang.Double> getMathSinFunction()

getNumberPassThru

public static com.gs.collections.api.block.function.Function<java.lang.Number,java.lang.Number> getNumberPassThru()

getIntegerPassThru

public static com.gs.collections.api.block.function.Function<java.lang.Integer,java.lang.Integer> getIntegerPassThru()

getLongPassThru

public static com.gs.collections.api.block.function.Function<java.lang.Long,java.lang.Long> getLongPassThru()

getDoublePassThru

public static com.gs.collections.api.block.function.Function<java.lang.Double,java.lang.Double> getDoublePassThru()

getStringPassThru

public static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.String> getStringPassThru()

getStringTrim

public static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.String> getStringTrim()

getToString

public static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.String> getToString()

getNullSafeToString

public static com.gs.collections.api.block.function.Function<java.lang.Object,java.lang.String> getNullSafeToString(java.lang.String defaultValue)

toBooleanComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toBooleanComparator(com.gs.collections.api.block.function.primitive.BooleanFunction<T> function)

toByteComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toByteComparator(com.gs.collections.api.block.function.primitive.ByteFunction<T> function)

toCharComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toCharComparator(com.gs.collections.api.block.function.primitive.CharFunction<T> function)

toFloatComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toFloatComparator(com.gs.collections.api.block.function.primitive.FloatFunction<T> function)

toShortComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toShortComparator(com.gs.collections.api.block.function.primitive.ShortFunction<T> function)

toIntComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toIntComparator(com.gs.collections.api.block.function.primitive.IntFunction<T> function)

toDoubleComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toDoubleComparator(com.gs.collections.api.block.function.primitive.DoubleFunction<T> function)

toLongComparator

public static <T> com.gs.collections.api.block.SerializableComparator<T> toLongComparator(com.gs.collections.api.block.function.primitive.LongFunction<T> function)

getStringToInteger

public static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.Integer> getStringToInteger()

withDefault

public static <T,V> com.gs.collections.api.block.function.Function<T,V> withDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                                    V defaultValue)

nullSafe

public static <T,V> com.gs.collections.api.block.function.Function<T,V> nullSafe(com.gs.collections.api.block.function.Function<? super T,? extends V> function)

nullSafe

public static <T,V> com.gs.collections.api.block.function.Function<T,V> nullSafe(com.gs.collections.api.block.function.Function<? super T,? extends V> function,
                                                                 V nullValue)

firstOfPair

public static <V1> com.gs.collections.api.block.function.Function<com.gs.collections.api.tuple.Pair<V1,?>,V1> firstOfPair()

secondOfPair

public static <V2> com.gs.collections.api.block.function.Function<com.gs.collections.api.tuple.Pair<?,V2>,V2> secondOfPair()

bind

public static <T,P,R> com.gs.collections.api.block.function.Function<T,R> bind(com.gs.collections.api.block.function.Function2<? super T,? super P,? extends R> function,
                                                               P parameter)

Bind the parameter passed to a Function2 into a new Function.

Parameters:

function - The Function2 to delegate the invocation to.

parameter - The parameter the use in the invocation of the delegate function.

Returns:

A new Function

bind

public static <T1,T2> com.gs.collections.api.block.procedure.Procedure<T1> bind(com.gs.collections.api.block.procedure.Procedure<? super T2> delegate,
                                                                com.gs.collections.api.block.function.Function<? super T1,T2> function)

Bind the input of a Procedure to the result of an function, returning a new Procedure.

Parameters:

delegate - The Procedure to delegate the invocation to.

function - The Function that will create the input for the delegate

Returns:

A new Procedure

bind

public static <T1,T2> com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<T1> bind(com.gs.collections.api.block.procedure.primitive.ObjectIntProcedure<? super T2> delegate,
                                                                                   com.gs.collections.api.block.function.Function<? super T1,T2> function)

Bind the input of a ObjectIntProcedure to the result of an function, returning a new ObjectIntProcedure.

Parameters:

delegate - The ObjectIntProcedure to delegate the invocation to.

function - The Function that will create the input for the delegate

Returns:

A new ObjectIntProcedure

bind

public static <T1,T2,T3> com.gs.collections.api.block.procedure.Procedure2<T1,T3> bind(com.gs.collections.api.block.procedure.Procedure2<? super T2,T3> delegate,
                                                                       com.gs.collections.api.block.function.Function<? super T1,T2> function)

Bind the input of the first argument of a Procedure2 to the result of an function, returning a new Procedure2.

Parameters:

delegate - The Procedure2 to delegate the invocation to.

function - The Function that will create the input for the delegate

Returns:

A new Procedure2

squaredInteger

public static com.gs.collections.api.block.function.Function<java.lang.Integer,java.lang.Integer> squaredInteger()

firstNotNullValue

public static <T,V> com.gs.collections.api.block.function.Function<T,V> firstNotNullValue(com.gs.collections.api.block.function.Function<T,V>... functions)

firstNotEmptyStringValue

public static <T> com.gs.collections.api.block.function.Function<T,java.lang.String> firstNotEmptyStringValue(com.gs.collections.api.block.function.Function<T,java.lang.String>... functions)

firstNotEmptyCollectionValue

public static <T1,T2,I extends java.lang.Iterable<T2>> com.gs.collections.api.block.function.Function<T1,I> firstNotEmptyCollectionValue(com.gs.collections.api.block.function.Function<T1,I>... functions)

ifTrue

public static <T,V> com.gs.collections.api.block.function.Function<T,V> ifTrue(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                               com.gs.collections.api.block.function.Function<? super T,? extends V> function)

ifElse

public static <T,V> com.gs.collections.api.block.function.Function<T,V> ifElse(com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                               com.gs.collections.api.block.function.Function<? super T,? extends V> trueFunction,
                                                               com.gs.collections.api.block.function.Function<? super T,? extends V> falseFunction)

caseDefault

public static <T extends java.lang.Comparable<? super T>,V> CaseFunction<T,V> caseDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> defaultFunction)

caseDefault

public static <T extends java.lang.Comparable<? super T>,V> CaseFunction<T,V> caseDefault(com.gs.collections.api.block.function.Function<? super T,? extends V> defaultFunction,
                                                                          com.gs.collections.api.block.predicate.Predicate<? super T> predicate,
                                                                          com.gs.collections.api.block.function.Function<? super T,? extends V> function)

synchronizedEach

public static <T,V> com.gs.collections.api.block.function.Function<T,V> synchronizedEach(com.gs.collections.api.block.function.Function<T,V> function)

classForName

public static com.gs.collections.api.block.function.Function<java.lang.String,java.lang.Class<?>> classForName()

chain

public static <T1,T2,T3> Functions.FunctionChain<T1,T2,T3> chain(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                 com.gs.collections.api.block.function.Function<? super T2,T3> function2)

chainBoolean

public static <T1,T2> Functions.BooleanFunctionChain<T1,T2> chainBoolean(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                         com.gs.collections.api.block.function.primitive.BooleanFunction<? super T2> function2)

chainByte

public static <T1,T2> Functions.ByteFunctionChain<T1,T2> chainByte(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                   com.gs.collections.api.block.function.primitive.ByteFunction<? super T2> function2)

chainChar

public static <T1,T2> Functions.CharFunctionChain<T1,T2> chainChar(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                   com.gs.collections.api.block.function.primitive.CharFunction<? super T2> function2)

chainDouble

public static <T1,T2> Functions.DoubleFunctionChain<T1,T2> chainDouble(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                       com.gs.collections.api.block.function.primitive.DoubleFunction<? super T2> function2)

chainFloat

public static <T1,T2> Functions.FloatFunctionChain<T1,T2> chainFloat(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                     com.gs.collections.api.block.function.primitive.FloatFunction<? super T2> function2)

chainInt

public static <T1,T2> Functions.IntFunctionChain<T1,T2> chainInt(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                 com.gs.collections.api.block.function.primitive.IntFunction<? super T2> function2)

chainLong

public static <T1,T2> Functions.LongFunctionChain<T1,T2> chainLong(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                   com.gs.collections.api.block.function.primitive.LongFunction<? super T2> function2)

chainShort

public static <T1,T2> Functions.ShortFunctionChain<T1,T2> chainShort(com.gs.collections.api.block.function.Function<T1,T2> function1,
                                                     com.gs.collections.api.block.function.primitive.ShortFunction<? super T2> function2)

pair

public static <T,V1,V2> com.gs.collections.api.block.function.Function<T,com.gs.collections.api.tuple.Pair<V1,V2>> pair(com.gs.collections.api.block.function.Function<T,V1> function1,
                                                                                                        com.gs.collections.api.block.function.Function<T,V2> function2)

getKeyFunction

public static <K> com.gs.collections.api.block.function.Function<java.util.Map.Entry<K,?>,K> getKeyFunction()

Returns:

A function that gets the key out of a Map.Entry

getValueFunction

public static <V> com.gs.collections.api.block.function.Function<java.util.Map.Entry<?,V>,V> getValueFunction()

Returns:

A function that gets the value out of a Map.Entry

getSizeOf

public static com.gs.collections.api.block.function.Function<java.lang.Iterable<?>,java.lang.Integer> getSizeOf()

Returns:

A function that gets the size of an Iterable