Transaction (iplass-core 3.1.3 API)

既知の実装クラスのリスト:

LocalTransaction, NoTransaction
```
public interface Transaction
```
トランザクションを表すインタフェースです。
トランザクションを制御するためのメソッドを持っています。

トランザクション制御コード例
※現在起動中のトランザクションと別に新規にトランザクション処理を起動する場合
```
 
 EntityManager em = ...
 Entity e = ...
 
 //新規にトランザクションを起動
 Transaction.requiresNew(t -> {
   
   em.insert(e);
   
   //コミット成功時に実行する処理を追加
   t.afterCommit(() -> {
     System.out.println("committed");
   });
   
   :
   :
   
 });
 
```

フィールドのサマリー

フィールド
修飾子とタイプフィールドと説明

static Transaction NO_TRANSACTION
トランザクションがない状態を表すTransactionのインスタンスです。

フィールド
修飾子とタイプ	フィールドと説明
`static Transaction`	`NO_TRANSACTION` トランザクションがない状態を表すTransactionのインスタンスです。

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド abstractメソッドデフォルト・メソッド
修飾子とタイプ	メソッドと説明
`void`	`addTransactionListener(TransactionListener listener)` このトランザクションのcommit、rollbackを監視するリスナーを登録します。
`default void`	`afterCommit(java.lang.Runnable func)` このトランザクションがcommitされた場合、funcを実行します。
`default void`	`afterRollback(java.lang.Runnable func)` このトランザクションがrollbackされた場合、funcを実行します。
`void`	`commit()` トランザクションをコミットします。
`java.lang.Object`	`getAttribute(java.lang.Object key)` このトランザクションコンテキストに紐づけられている特定の属性を取得します。
`static Transaction`	`getCurrent()` 現在の実行コンテキストに関連しているトランザクションのインスタンスを取得します。
`TransactionStatus`	`getStatus()` トランザクションの状態を取得します。
`boolean`	`isReadOnly()` このトランザクションがReadOnlyとしてマークされているかどうかを取得します。
`boolean`	`isRollbackOnly()` このトランザクションがsetRollbackOnlyされているかどうかを取得します。
`static void`	`readOnly(java.util.function.Consumer<Transaction> func)` トランザクションをreadOnlyモードで起動します。
`static <R> R`	`readOnly(java.util.function.Function<Transaction,R> func)` トランザクションをreadOnlyモードで起動します。
`java.lang.Object`	`removeAttribute(java.lang.Object key)` このトランザクションコンテキストに紐づけられている特定の属性を削除します。
`static void`	`required(java.util.function.Consumer<Transaction> func)` トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。
`static <R> R`	`required(java.util.function.Function<Transaction,R> func)` トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。
`static void`	`requiresNew(java.util.function.Consumer<Transaction> func)` 新規にトランザクションを起動し、funcを実行します。
`static <R> R`	`requiresNew(java.util.function.Function<Transaction,R> func)` 新規にトランザクションを起動し、funcを実行します。
`void`	`rollback()` トランザクションをロールバックします。
`void`	`setAttribute(java.lang.Object key, java.lang.Object value)` このトランザクションのコンテキストに特定の属性を紐づけます。
`void`	`setRollbackOnly()` このトランザクションをロールバックするものとしてマークします。
`static void`	`with(Propagation propagation, java.util.function.Consumer<Transaction> func)` 指定のpropagationで、トランザクションを起動しfuncを実行します。
`static <R> R`	`with(Propagation propagation, java.util.function.Function<Transaction,R> func)` 指定のpropagationで、トランザクションを起動しfuncを実行します。
`static void`	`with(TransactionOption option, java.util.function.Consumer<Transaction> func)` 指定のoptionで、トランザクションを起動しfuncを実行します。
`static <R> R`	`with(TransactionOption option, java.util.function.Function<Transaction,R> func)` 指定のoptionで、トランザクションを起動しfuncを実行します。

- フィールドの詳細
  - NO_TRANSACTION
```
static final Transaction NO_TRANSACTION
```
    トランザクションがない状態を表すTransactionのインスタンスです。トランザクションがまだ開始されていない状態、もしくはトランザクションがサスペンドされている場合に当インスタンスが返却されます。
    getStatus()は常にTransactionStatus.NONEを返します。
    setAttribute(Object, Object)などのその他のトランザクション制御メソッドはなにも処理しません。
- メソッドの詳細
  - getCurrent
```
static Transaction getCurrent()
```
    現在の実行コンテキストに関連しているトランザクションのインスタンスを取得します。もし、トランザクションが開始されていない場合は、NO_TRANSACTIONが返却されます。
    
    戻り値:
  - commit
```
void commit()
```
    トランザクションをコミットします。
  - rollback
```
void rollback()
```
    トランザクションをロールバックします。
  - setRollbackOnly
```
void setRollbackOnly()
```
    このトランザクションをロールバックするものとしてマークします。 setRollbackOnlyされたトランザクションは最終的にはロールバックされます。
  - isRollbackOnly
```
boolean isRollbackOnly()
```
    このトランザクションがsetRollbackOnlyされているかどうかを取得します。
    
    戻り値:
    
    setRollbackOnlyの場合true
  - isReadOnly
```
boolean isReadOnly()
```
    このトランザクションがReadOnlyとしてマークされているかどうかを取得します。
    
    戻り値:
  - getStatus
```
TransactionStatus getStatus()
```
    トランザクションの状態を取得します。
    
    戻り値:
  - setAttribute
```
void setAttribute(java.lang.Object key,
                  java.lang.Object value)
```
    このトランザクションのコンテキストに特定の属性を紐づけます。
    
    パラメータ:
    
    key - 属性のキー
    
    value - 属性の値
  - getAttribute
```
java.lang.Object getAttribute(java.lang.Object key)
```
    このトランザクションコンテキストに紐づけられている特定の属性を取得します。同一トランザクション内でsetAttribute()したものがあれば、その値が取得できます。
    
    パラメータ:
    
    key - 属性のキー
    
    戻り値:
    
    属性の値
  - removeAttribute
```
java.lang.Object removeAttribute(java.lang.Object key)
```
    このトランザクションコンテキストに紐づけられている特定の属性を削除します。
    
    パラメータ:
    
    key - 属性のキー
    
    戻り値:
    
    削除された値
  - addTransactionListener
```
void addTransactionListener(TransactionListener listener)
```
    このトランザクションのcommit、rollbackを監視するリスナーを登録します。
    
    パラメータ:
    
    listener -
  - afterCommit
```
default void afterCommit(java.lang.Runnable func)
```
    このトランザクションがcommitされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。
    
    パラメータ:
    
    func -
  - afterRollback
```
default void afterRollback(java.lang.Runnable func)
```
    このトランザクションがrollbackされた場合、funcを実行します。 funcの引数にはこのトランザクションが渡されます。
    
    パラメータ:
    
    func -
  - required
```
static void required(java.util.function.Consumer<Transaction> func)
```
    トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。
    
    パラメータ:
    
    func -
  - required
```
static <R> R required(java.util.function.Function<Transaction,R> func)
```
    トランザクションが開始していない場合はトランザクションを起動し、funcを実行します。トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。
    
    パラメータ:
    
    func -
    
    戻り値:
    
    funcが返却する値
  - requiresNew
```
static void requiresNew(java.util.function.Consumer<Transaction> func)
```
    新規にトランザクションを起動し、funcを実行します。トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。
    
    パラメータ:
    
    func -
  - requiresNew
```
static <R> R requiresNew(java.util.function.Function<Transaction,R> func)
```
    新規にトランザクションを起動し、funcを実行します。トランザクション制御方法は、TransactionOptionのデフォルトが適用されます。
    
    パラメータ:
    
    func -
    
    戻り値:
    
    funcが返却する値
  - readOnly
```
static void readOnly(java.util.function.Consumer<Transaction> func)
```
    トランザクションをreadOnlyモードで起動します。ただし、すでにトランザクションが開始されている場合、新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。これは、
    TransactionOption.propagation=REQUIRED
    TransactionOption.readOnly=true
    でトランザクションを起動することを示します。
    
    パラメータ:
    
    func -
  - readOnly
```
static <R> R readOnly(java.util.function.Function<Transaction,R> func)
```
    トランザクションをreadOnlyモードで起動します。ただし、すでにトランザクションが開始されている場合、新規にトランザクションは開始せず既存のトランザクションをそのまま利用します。これは、
    TransactionOption.propagation=REQUIRED
    TransactionOption.readOnly=true
    でトランザクションを起動することを示します。
    
    パラメータ:
    
    func -
    
    戻り値:
    
    funcが返却する値
  - with
```
static void with(Propagation propagation,
                 java.util.function.Consumer<Transaction> func)
```
    指定のpropagationで、トランザクションを起動しfuncを実行します。
    
    パラメータ:
    
    propagation -
    
    func -
  - with
```
static <R> R with(Propagation propagation,
                  java.util.function.Function<Transaction,R> func)
```
    指定のpropagationで、トランザクションを起動しfuncを実行します。
    
    パラメータ:
    
    propagation -
    
    func -
    
    戻り値:
    
    funcが返却する値
  - with
```
static void with(TransactionOption option,
                 java.util.function.Consumer<Transaction> func)
```
    指定のoptionで、トランザクションを起動しfuncを実行します。
    
    パラメータ:
    
    option -
    
    func -
  - with
```
static <R> R with(TransactionOption option,
                  java.util.function.Function<Transaction,R> func)
```
    指定のoptionで、トランザクションを起動しfuncを実行します。
    
    パラメータ:
    
    option -
    
    func -
    
    戻り値:
    
    funcが返却する値

インタフェース Transaction

トランザクション制御コード例

フィールドのサマリー

メソッドのサマリー

フィールドの詳細

NO_TRANSACTION

メソッドの詳細

getCurrent

commit

rollback

setRollbackOnly

isRollbackOnly

isReadOnly

getStatus

setAttribute

getAttribute

removeAttribute

addTransactionListener

afterCommit

afterRollback

required

required

requiresNew

requiresNew

readOnly

readOnly

with

with

with

with