com.speedment.runtime.core.manager

Interface Remover<ENTITY>

Type Parameters:

ENTITY - the entity type

All Superinterfaces:

Consumer<ENTITY>, Function<ENTITY,ENTITY>, UnaryOperator<ENTITY>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface Remover<ENTITY>
extends UnaryOperator<ENTITY>, Consumer<ENTITY>

An action that takes an entity and removes it from a data store. This interface extends the standard UnaryOperator- and Consumer-interfaces so that it can be used inside a Stream.

Since:

3.0.1

Author:

Per Minborg

Method Summary

Modifier and Type	Method and Description
default void	accept(ENTITY entity) Removes the entity from the data store.
ENTITY	apply(ENTITY entity) Removes the provided entity from the underlying database and returns the provided entity instance.

Methods inherited from interface java.util.function.UnaryOperator

identity

Methods inherited from interface java.util.function.Function

andThen, compose

Methods inherited from interface java.util.function.Consumer

andThen

Method Detail

apply

ENTITY apply(ENTITY entity)
      throws SpeedmentException

Removes the provided entity from the underlying database and returns the provided entity instance. If the deletion fails for any reason, an unchecked SpeedmentException is thrown.

Entities are uniquely identified by their primary key(s).

Specified by:

apply in interface Function<ENTITY,ENTITY>

Parameters:

entity - to remove

Returns:

the provided entity instance

Throws:

SpeedmentException - if the underlying database throws an exception (e.g. SQLException)

accept

default void accept(ENTITY entity)

Removes the entity from the data store. The specified instance might be modified by this method in some implementations.

Specified by:

accept in interface Consumer<ENTITY>

Parameters:

entity - the entity to remove

Throws:

SpeedmentException - if removing the entity failed