Package org.approvej.approve

Interface Approver

All Superinterfaces:

Consumer<String>, Function<String,ApprovalResult>

All Known Implementing Classes:

FileApprover, InplaceApprover

public interface Approver
extends Consumer<String>, Function<String,ApprovalResult>

A Consumer that approved a printed value and (optionally) stores the value in some fashion if approved for a later execution.

Method Summary

Modifier and Type	Method	Description
default void	accept(String received)	Deprecated, for removal: This API element is subject to removal in a future version. use Function.apply(Object) to get an ApprovalResult and (optionally) call ApprovalResult.throwIfNotApproved() to achieve the same outcome.

Methods inherited from interface java.util.function.Consumer

andThen

Methods inherited from interface java.util.function.Function

andThen, apply, compose

Method Details

accept

@Deprecated(since="0.8.6",
            forRemoval=true)
default void accept(String received)

Deprecated, for removal: This API element is subject to removal in a future version.

use Function.apply(Object) to get an ApprovalResult and (optionally) call ApprovalResult.throwIfNotApproved() to achieve the same outcome.

Approves a received value against a previously approved value.

Specified by:

accept in interface Consumer<String>

Parameters:

received - the received value

Throws:

ApprovalError - if the received value was not approved