com.speedment.runtime.bulk.BulkOperation Maven / Gradle / Ivy
Show all versions of tool-deploy Show documentation
/*
*
* Copyright (c) 2006-2019, Speedment, Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); You may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.runtime.bulk;
import com.speedment.runtime.bulk.internal.BulkOperationBuilder;
import com.speedment.runtime.core.manager.Manager;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;
import java.util.function.Supplier;
import java.util.stream.Stream;
/**
*
* @author Per Minborg
*/
public interface BulkOperation {
Stream> operations();
public static Builder builder() {
return new BulkOperationBuilder();
}
interface Builder {
/**
* Creates and returns a new Persist builder that can be used to build a
* Persist Operation.
*
* @param type
* @param manager to use when persisting entities
* @return Persist builder that can be used to build a Persist Operation
*/
Persist persist(Manager manager);
/**
* Creates and returns a new Update builder that can be used to build an
* Update Operation.
*
* @param type
* @param manager to use when updating entities
* @return Update builder that can be used to build an Update Operation
*/
Update update(Manager manager);
/**
* Creates and returns a new Remove builder that can be used to build a
* Remove Operation.
*
* If {@link Remove#where(java.util.function.Predicate) } is not called
* on the Remove builder, then all entities will be removed.
*
* @param type
* @param manager to use when removing entities
* @return Remove builder that can be used to build a Remove Operation
*/
Remove remove(Manager manager);
/**
* Creates and returns a new immutable BulkOperation comprising all the
* steps defined by the Builder.
*
* @return a new immutable BulkOperation comprising all the steps
* defined by the Builder
*/
BulkOperation build();
interface Persist extends HasValues {
}
interface Update extends Builder, HasWhere>, HasSet> {
}
interface Remove extends Builder, HasWhere> {
}
interface HasWhere {
/**
* Specifies for what entities the operation should be carried out.
*
* Specifying several
* {@link #where(java.util.function.Predicate) where} filters will
* be equivalent to performing a logical AND on the provided
* filters.
*
* @param filter to apply
* @return a builder where the given filter has been applied
*/
B where(Predicate filter);
}
interface HasSet {
/**
* Specifies an entity mapper for the operation whereby the mapper
* will mutate the entity in some way when applied.
*
* Specifying several
* {@link #compute(java.util.function.Function) compute()} and/or
* several {@link #set(java.util.function.Consumer) set()}
* operations will be equivalent to applying all those operations
* on entities (e.g. a functional reduction)
*
* @param mapper to apply when updating entities
* @return a builder where the given mapper has been applied
*/
B compute(Function mapper);
/**
* Specifies an entity consumer for the operation whereby the
* consumer will mutate the entity in some way when applied.
*
* Specifying several
* {@link #compute(java.util.function.Function) compute()} and/or
* several {@link #set(java.util.function.Consumer) set()}
* operations will be equivalent to applying all those operations
* on entities (e.g. a functional reduction)
*
* @param consumer to apply when updating entities
* @return a builder where the given consumer has been applied
*/
B set(Consumer consumer);
}
interface HasValues {
/**
* Specifies a Supplier of a Stream, whereby the stream's elements
* will be persisted using the given manager.
*
* @param generatorSupplier to apply when constructing entities
* @return a builder where the given generatorSupplier has been
* applied
*/
B values(Supplier> generatorSupplier);
}
}
}