oracle.kv.OperationFactory Maven / Gradle / Ivy
Show all versions of oracle-nosql-server Show documentation
/*-
* Copyright (C) 2011, 2018 Oracle and/or its affiliates. All rights reserved.
*
* This file was distributed by Oracle as part of a version of Oracle NoSQL
* Database made available at:
*
* http://www.oracle.com/technetwork/database/database-technologies/nosqldb/downloads/index.html
*
* Please see the LICENSE file included in the top-level directory of the
* appropriate version of Oracle NoSQL Database for a copy of the license and
* additional information.
*/
package oracle.kv;
/**
* A factory to create operations that can be batched for execution by {@link
* KVStore#execute KVStore.execute}.
*
* Each operation created here operates on a single key and matches the
* corresponding operation defined in KVStore. For example, the Operation
* generated by the {@link #createPut createPut} method corresponds to the
* {@link KVStore#put put} method. The argument pattern for creating the
* operation is similar. It differs in the following respects:
*
* -
* The durability argument is not passed, since that argument applies to the
* execution of the entire batch of operations and is passed in to the {@link
* KVStore#execute execute} method.
*
* -
* {@link ReturnValueVersion.Choice} is passed instead of {@link
* ReturnValueVersion}.
*
* -
* An additional argument, {@code abortIfUnsuccessful} is passed.
*
*
*
* The return values associated with operations similarly match the
* descriptions for the corresponding methods described in in {@link KVStore}.
* They are, however, retrieved differently: the status, return value, previous
* value and version are packaged together in {@link OperationResult}.
*
*/
public interface OperationFactory {
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#put put} method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Put operation
*
* @see KVStore#put put
* @see KVStore#execute execute
*/
public Operation createPut(Key key, Value value);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#put put} method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link KVStore#put put}
* method returns null.
*
* @return the created Put operation
*
* @see KVStore#put put
* @see KVStore#execute execute
*/
public Operation createPut(Key key,
Value value,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfAbsent putIfAbsent}
* method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Put operation
*
* @see KVStore#putIfAbsent putIfAbsent
* @see KVStore#execute execute
*/
public Operation createPutIfAbsent(Key key, Value value);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfAbsent putIfAbsent}
* method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link
* KVStore#putIfAbsent putIfAbsent} method returns null.
*
* @return the created Put operation
*
* @see KVStore#putIfAbsent putIfAbsent
* @see KVStore#execute execute
*/
public Operation createPutIfAbsent(Key key,
Value value,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfPresent putIfPresent}
* method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Put operation
*
* @see KVStore#putIfPresent putIfPresent
* @see KVStore#execute execute
*/
public Operation createPutIfPresent(Key key, Value value);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfPresent putIfPresent}
* method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link
* KVStore#putIfPresent putIfPresent} method returns null.
*
* @return the created Put operation
*
* @see KVStore#putIfPresent putIfPresent
* @see KVStore#execute execute
*/
public Operation createPutIfPresent(Key key,
Value value,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfVersion putIfVersion}
* method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Put operation
*
* @see KVStore#putIfVersion putIfVersion
* @see KVStore#execute execute
*/
public Operation createPutIfVersion(Key key, Value value, Version version);
/**
* Create a Put operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* are identical to that of the {@link KVStore#putIfVersion putIfVersion}
* method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link
* KVStore#putIfVersion putIfVersion} method returns null.
*
* @return the created Put operation
*
* @see KVStore#putIfVersion putIfVersion
* @see KVStore#execute execute
*/
public Operation createPutIfVersion(Key key,
Value value,
Version version,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
/**
* Create a Delete operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* when executed are identical to that of the {@link KVStore#delete delete}
* method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Delete operation
*
* @see KVStore#delete delete
* @see KVStore#execute execute
*/
public Operation createDelete(Key key);
/**
* Create a Delete operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* when executed are identical to that of the {@link KVStore#delete delete}
* method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link KVStore#delete
* delete} method returns false.
*
* @return the created Delete operation
*
* @see KVStore#delete delete
* @see KVStore#execute execute
*/
public Operation createDelete(Key key,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
/**
* Create a Delete operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* when executed are identical to that of the {@link
* KVStore#deleteIfVersion deleteIfVersion} method.
*
* The previous value is not returned by this method and the
* {@code abortIfUnsuccessful} property is false.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @return the created Delete operation
*
* @see KVStore#deleteIfVersion deleteIfVersion
* @see KVStore#execute execute
*/
public Operation createDeleteIfVersion(Key key, Version version);
/**
* Create a Delete operation suitable for use as an argument to the {@link
* KVStore#execute execute} method. The semantics of the returned operation
* when executed are identical to that of the {@link
* KVStore#deleteIfVersion deleteIfVersion} method.
*
* The result of evaluating the operation, or the resulting exception,
* after the call to {@link KVStore#execute execute} is available as an
* {@link OperationResult}.
*
* @param abortIfUnsuccessful is true if this operation should cause the
* {@link KVStore#execute execute} transaction to abort when the operation
* fails, where failure is the condition when the {@link
* KVStore#deleteIfVersion deleteIfVersion} method returns false.
*
* @return the created Delete operation
*
* @see KVStore#deleteIfVersion deleteIfVersion
* @see KVStore#execute execute
*/
public Operation
createDeleteIfVersion(Key key,
Version version,
ReturnValueVersion.Choice prevReturn,
boolean abortIfUnsuccessful);
}