Transaction (Gremlin Core: The Primary Components of TinkerPop3 3.0.0.M7 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable
```
public interface Transaction
extends java.io.Closeable
```
A set of methods that allow for control of transactional behavior of a Graph instance.

Author:

Marko A. Rodriguez (http://markorodriguez.com), Stephen Mallette (http://stephen.genoprime.com), TinkerPop Community (http://tinkerpop.com)

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`Transaction.CLOSE_BEHAVIOR` Behaviors to supply to the `onClose(java.util.function.Consumer)`.
`static class`	`Transaction.Exceptions`
`static class`	`Transaction.READ_WRITE_BEHAVIOR` Behaviors to supply to the `onReadWrite(java.util.function.Consumer)`.
`static class`	`Transaction.Workload<R>` A `Transaction.Workload` represents a unit of work constructed by the `submit(java.util.function.Function)` method on the `Transaction` interface.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()` Closes the transaction where the default close behavior will be executed.
`void`	`commit()` Commits a transaction.
`<G extends Graph> G`	`create()` Creates a transaction that can be executed across multiple threads.
`boolean`	`isOpen()` Determines if a transaction is currently open.
`Transaction`	`onClose(java.util.function.Consumer<Transaction> consumer)` Describes what happens to a transaction on a call to `AutoCloseable.close()`.
`Transaction`	`onReadWrite(java.util.function.Consumer<Transaction> consumer)` Describes how a transaction is started when a read or a write occurs.
`void`	`open()` Opens a transaction.
`void`	`readWrite()` An internal function that signals a read or a write has occurred - not meant to be called directly by end users.
`void`	`rollback()` Rolls back a transaction.
`<R> Transaction.Workload<R>`	`submit(java.util.function.Function<Graph,R> work)` Submit a unit of work that represents a transaction returning a `Transaction.Workload` that can be automatically retried in the event of failure.

- Method Detail
  - open
```
void open()
```
    Opens a transaction.
  - commit
```
void commit()
```
    Commits a transaction.
  - rollback
```
void rollback()
```
    Rolls back a transaction.
  - submit
```
<R> Transaction.Workload<R> submit(java.util.function.Function<Graph,R> work)
```
    Submit a unit of work that represents a transaction returning a Transaction.Workload that can be automatically retried in the event of failure.
  - create
```
<G extends Graph> G create()
```
    Creates a transaction that can be executed across multiple threads.
  - isOpen
```
boolean isOpen()
```
    Determines if a transaction is currently open.
  - readWrite
```
void readWrite()
```
    An internal function that signals a read or a write has occurred - not meant to be called directly by end users.
  - close
```
void close()
```
    Closes the transaction where the default close behavior will be executed.
    
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
  - onReadWrite
```
Transaction onReadWrite(java.util.function.Consumer<Transaction> consumer)
```
    Describes how a transaction is started when a read or a write occurs. This value can be set using standard behaviors defined in Transaction.READ_WRITE_BEHAVIOR or a mapper Consumer function.
  - onClose
```
Transaction onClose(java.util.function.Consumer<Transaction> consumer)
```
    Describes what happens to a transaction on a call to AutoCloseable.close(). This value can be set using standard behavior defined in Transaction.CLOSE_BEHAVIOR or a mapper Consumer function.

Interface Transaction

Nested Class Summary

Method Summary

Method Detail

open

commit

rollback

submit

create

isOpen

readWrite

close

onReadWrite

onClose