com.speedment.runtime.core.manager

Interface Persister<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 Persister<ENTITY>
extends UnaryOperator<ENTITY>, Consumer<ENTITY>

An action that takes an entity and persists it to 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) Persists the entity in the data store.
ENTITY	apply(ENTITY entity) Persists the provided entity to the underlying database and returns a potentially updated entity.

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

Persists the provided entity to the underlying database and returns a potentially updated entity. If the persistence fails for any reason, an unchecked SpeedmentException is thrown.

It is unspecified if the returned updated entity is the same provided entity instance or another entity instance. It is erroneous to assume either, so you should use only the returned entity after the method has been called. However, it is guaranteed that the provided entity is untouched if an exception is thrown.

The fields of returned entity instance may differ from the provided entity fields due to auto generated column(s) or because of any other modification that the underlying database imposed on the persisted entity.

Specified by:

apply in interface Function<ENTITY,ENTITY>

Parameters:

entity - to persist

Returns:

an entity reflecting the result of the persisted entity

Throws:

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

accept

default void accept(ENTITY entity)

Persists the entity in 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 persist

Throws:

SpeedmentException - if persisting the entity failed