Package ch.tocco.nice2.persist.core.api.exec

Class PersistTasks

java.lang.Object

ch.tocco.nice2.persist.core.api.exec.PersistTasks

public final class PersistTasks
extends Object

Method Summary

Modifier and Type	Method	Description
static <A> PersistTask<A,Boolean>	and(PersistTask<A,Boolean>... predicates)	the classic 'and' behaviour for tasks which returns a Boolean
static <A, B> PersistTaskIterable<A,B>	asIterableTask(PersistTask<A,Iterable<B>> task)
static <A, B> PersistTask<A,B>	empty()	Always return null.
static <A, B> PersistTask<A,B>	fromFunction(Function<A,B> function)	Create a persist task from a guava function.
static <A> PersistTask<A,Boolean>	fromPredicate(Predicate<A> predicate)	Create a persist task from a guava predicate.
static <A> PersistTask<A,A>	identity()	Return the argument.
static <A> PersistTask<A,Boolean>	isNull()
static PersistTask<String,Boolean>	isNullOrEmpty()
static <R> NoArgPersistTask<R>	noArg(R object)	helper method to get a NoArgPersistTask from a object
static <A> PersistTask<A,Boolean>	not(PersistTask<A,Boolean> predicate)
static <A, B> PersistTask<A,B>	of(B value)	Creates a task that returns the given value on each run.
static <A, B> OptionalTask<A,B>	opt(OptionalTask<A,B> task)	This is for casting lambdas to have the compiler use the OptionalTask interface when using combinators like PersistTask.compose(PersistTask) that expect the general PersistTask interface.
static <A> PersistTask<A,Boolean>	or(PersistTask<A,Boolean>... predicates)	the classic 'or' behaviour for tasks which returns a Boolean
static <P, R> NoTaskDataPartitionedPersistTask<P,R>	partitionIterableTask(PersistTask<Iterable<P>,Iterable<R>> task)	partition a task that returns an iterable
static PersistTask<Void,Void>	partitionQuery(PrimaryKeyQueryBuilder queryBuilder, PersistTask<Iterable<Entity>,Void> task, int partitionSize)	create a partitioned task from a query builder and a task to handle the partitions
static PersistTask<Void,Void>	partitionQuery(QueryBuilder queryBuilder, PersistTask<Iterable<Entity>,Void> task, int partitionSize)	Deprecated. use partitionQuery(PrimaryKeyQueryBuilder, PersistTask, int)
static PersistTask<Void,Iterable<SimpleEntityId>>	partitionQueryGatherIds(PrimaryKeyQueryBuilder queryBuilder, PersistTask<Iterable<Entity>,Iterable<Entity>> task, int partitionSize)	create a partitioned task from a query builder and a task to handle the partitions transform returned entities into entity ids
static <P> NoTaskDataPartitionedPersistTask<P,Void>	partitionTask(PersistTask<Iterable<P>,Void> task)	partition a task
static <A, B> PersistTask<A,B>	require(OptionalTask<A,B> task)	Return a new task that throws an exception if the argument is not present.
static <A, B> PersistTask<A,B>	require(String msg, OptionalTask<A,B> task)	Return a new task that throws an exception if the argument is not present.
static PersistTaskIterable<EntityList,Entity>	unwrap()	Unwraps the Entity in the given entity list.
static PersistTaskIterable<Relation,Entity>	unwrapRelation()	Unwraps the Entity in the given relation.

Methods inherited from class java.lang.Object

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

Method Details

unwrap

public static PersistTaskIterable<EntityList,Entity> unwrap()

Unwraps the Entity in the given entity list.

unwrapRelation

public static PersistTaskIterable<Relation,Entity> unwrapRelation()

Unwraps the Entity in the given relation.

identity

public static <A> PersistTask<A,A> identity()

Return the argument.

empty

public static <A,
B> PersistTask<A,B> empty()

Always return null.

opt

public static <A,
B> OptionalTask<A,B> opt(OptionalTask<A,B> task)

This is for casting lambdas to have the compiler use the OptionalTask interface when using combinators like PersistTask.compose(PersistTask) that expect the general PersistTask interface.

require

public static <A,
B> PersistTask<A,B> require(String msg,
 OptionalTask<A,B> task)

Return a new task that throws an exception if the argument is not present. Can be used to require an argument for an OptionalTask.

Parameters:

msg - the error message for the exception

task - the task to check the argument for

require

public static <A,
B> PersistTask<A,B> require(OptionalTask<A,B> task)

Return a new task that throws an exception if the argument is not present. Can be used to require an argument for an OptionalTask.

Parameters:

task - the task to check the argument for

fromFunction

public static <A,
B> PersistTask<A,B> fromFunction(Function<A,B> function)

Create a persist task from a guava function.

asIterableTask

public static <A,
B> PersistTaskIterable<A,B> asIterableTask(PersistTask<A,Iterable<B>> task)

fromPredicate

public static <A> PersistTask<A,Boolean> fromPredicate(Predicate<A> predicate)

Create a persist task from a guava predicate.

isNull

public static <A> PersistTask<A,Boolean> isNull()

isNullOrEmpty

public static PersistTask<String,Boolean> isNullOrEmpty()

not

public static <A> PersistTask<A,Boolean> not(PersistTask<A,Boolean> predicate)

or

@SafeVarargs
public static <A> PersistTask<A,Boolean> or(PersistTask<A,Boolean>... predicates)

the classic 'or' behaviour for tasks which returns a Boolean

Returns:

true if one of the given tasks returns true, false otherwise If the returned Optional of a task is absent, it will be treated as a 'false'

and

@SafeVarargs
public static <A> PersistTask<A,Boolean> and(PersistTask<A,Boolean>... predicates)

the classic 'and' behaviour for tasks which returns a Boolean

Returns:

false if one of the given tasks returns false, true otherwise. If the returned Optional of a task is absent, it will be treated as a 'false'

of

public static <A,
B> PersistTask<A,B> of(B value)

Creates a task that returns the given value on each run.

partitionQuery

@Deprecated
public static PersistTask<Void,Void> partitionQuery(QueryBuilder queryBuilder,
 PersistTask<Iterable<Entity>,Void> task,
 int partitionSize)

Deprecated.

use partitionQuery(PrimaryKeyQueryBuilder, PersistTask, int)

create a partitioned task from a query builder and a task to handle the partitions

Parameters:

queryBuilder - the query builder to partition

task - the task to use on each partition

partitionSize - the size of the partitions

Returns:

the task

partitionQuery

public static PersistTask<Void,Void> partitionQuery(PrimaryKeyQueryBuilder queryBuilder,
 PersistTask<Iterable<Entity>,Void> task,
 int partitionSize)

create a partitioned task from a query builder and a task to handle the partitions

Parameters:

queryBuilder - the query builder to partition

task - the task to use on each partition

partitionSize - the size of the partitions

Returns:

the task

partitionQueryGatherIds

public static PersistTask<Void,Iterable<SimpleEntityId>> partitionQueryGatherIds(PrimaryKeyQueryBuilder queryBuilder,
 PersistTask<Iterable<Entity>,Iterable<Entity>> task,
 int partitionSize)

create a partitioned task from a query builder and a task to handle the partitions transform returned entities into entity ids

Parameters:

queryBuilder - the query builder to partition

task - the task to use on each partition

partitionSize - the size of the partitions

Returns:

the task

noArg

public static <R> NoArgPersistTask<R> noArg(R object)

helper method to get a NoArgPersistTask from a object

Type Parameters:

R - the type of the object

Parameters:

object - the object to return

Returns:

the no arg task

partitionTask

public static <P>
NoTaskDataPartitionedPersistTask<P,Void> partitionTask(PersistTask<Iterable<P>,Void> task)

partition a task

Type Parameters:

P - the argument type of the task, will be passed to the task in a list

Parameters:

task - the task to apply to each partition

Returns:

the partitioned task

partitionIterableTask

public static <P,
R>
NoTaskDataPartitionedPersistTask<P,R> partitionIterableTask(PersistTask<Iterable<P>,Iterable<R>> task)

partition a task that returns an iterable

Type Parameters:

P - the argument type of the task, will be passed to the task in a list

R - the return type of the task, will be returned as an iterable

Parameters:

task - the task to apply to each partition

Returns:

the partitioned task