LockModeType (javax.persistence-api 2.2 API)

java.lang.Object
- java.lang.Enum<LockModeType>
- - javax.persistence.LockModeType

すべての実装されたインタフェース:

java.io.Serializable, java.lang.Comparable<LockModeType>
```
public enum LockModeType
extends java.lang.Enum<LockModeType>
```
ロックモードはロックを取るEntityManagerメソッドの1つ(lockやfind、refresh)または Query.setLockMode()、TypedQuery.setLockMode()メソッドのいずれかにLockModeType 引数を渡すことによって指定できます。
ロックモードは楽観ロック、悲観ロックのどちらかを指定するのに使用されます。
楽観ロックはLockModeType.OPTIMISTICおよびLockModeType.OPTIMISTIC_FORCE_INCREMENT を使用して指定されます。ロックモードの値LockModeType.READおよびLockModeType.WRITEはそれぞれOPTIMISTIC およびOPTIMISTIC_FORCE_INCREMENTと同じ意味です。新しいアプリケーションでは後者を使用する方が好ましいでしょう。
LockModeType.OPTIMISTICおよびLockModeType.OPTIMISTIC_FORCE_INCREMENTのロックが要求された時の意味は次のとおりです。
トランザクションT1がバージョン管理されたオブジェクトでLockModeType.OPTIMISTIC型のロックを呼び出したした場合、エンティティマネージャーは次のいずれの現象も起こらないようにする必要があります。
- P1 (ダーティーリード): トランザクションT1が行を変更し、別のトランザクションT2がその後にその行を読み取り、 T1がコミットまたはロールバックされる前に変更された値を取得します。トランザクションT2は最終的に正常にコミットされます。 T1がコミットするかロールバックするか、T1が終了するのがT2がコミットする前か後かは問いません。
- P2 (ノンリピータブルリード): トランザクションT1が行を読み取り、T1がコミットされる前に別のトランザクションT2がその行を変更または削除します。両方のトランザクションは最終的に正常にコミットされます。
ロックモードはP1とP2の両方の現象を防止する必要があります。
さらに、LockModeType.OPTIMISTIC_FORCE_INCREMENTがバージョン管理されたオブジェクトで呼び出された場合は、エンティティのバージョンカラムが強制的に更新(インクリメント)されます。
JPAの実装ではバージョン管理されないオブジェクトに対する楽観ロックモードのサポートは必須ではありません。そのようなロックの呼び出しをサポートしていない場合はPersistenceExceptionを投げる必要があります。
ロックモードLockModeType.PESSIMISTIC_READおよびLockModeType.PESSIMISTIC_WRITE、 LockModeType.PESSIMISTIC_FORCE_INCREMENTは長期のデータベースロックを即時に取得するために使用されます。
LockModeType.PESSIMISTIC_READおよびLockModeType.PESSIMISTIC_WRITE、 LockModeType.PESSIMISTIC_FORCE_INCREMENTのロックが要求された時の意味は次のとおりです。
トランザクションT1がオブジェクトでLockModeType.PESSIMISTIC_READもしくはLockModeType.PESSIMISTIC_WRITE型のロックを呼び出したした場合、エンティティマネージャーは次のいずれの現象も起こらないようにする必要があります。
- P1 (ダーティーリード): トランザクションT1が行を変更し、別のトランザクションT2がその後にその行を読み取り、 T1がコミットまたはロールバックされる前に変更された値を取得します。
- P2 (ノンリピータブルリード): トランザクションT1が行を読み取り、T1がコミットもしくはロールバックされる前に別のトランザクションT2がその行を変更または削除します。
LockModeType.PESSIMISTIC_WRITEのロックをエンティティのインスタンスで取得する事でエンティティデータを更新を試みるトランザクションの処理を強制的に直列化することができます。 LLockModeType.PESSIMISTIC_READのロックを使用する事で、トランザクションの終了時にデータを再読み込みしてロックを取得する必要がなく、また他のトランザクションのデータを読み取りをブロックすることもなく、反復可能な読み取りセマンティクスを使用してデータを問い合わせできます。 LockModeType.PESSIMISTIC_WRITEのロックは、データの問い合わせに使用できますが、並行更新トランザクション間でデッドロックや更新の失敗の可能性が高くなります。
JPAの実装ではバージョン管理されたエンティティと同様にバージョン管理されていないエンティティでLockModeType.PESSIMISTIC_READ LockModeType.PESSIMISTIC_WRITE型のロックの使用をサポートする必要があります。
ロックを取得できず、データベースのロックの失敗によりトランザクションレベルのロールバックが発生した場合、プロバイダはPessimisticLockExceptionを投げ、 JTAトランザクションまたはEntityTransactionにロールバックのマークが付いていることを保証する必要があります。
ロックを取得できず、データベースのロックの失敗によりステートメントレベルのロールバックのみが発生した場合、プロバイダはLockTimeoutExceptionを投げる必要があります。 (トランザクションにロールバックをマークしてはいけません)
導入されたバージョン:

Java Persistence 1.0

列挙型定数のサマリー

列挙型定数
列挙型定数と説明
`NONE` ロックしない。
`OPTIMISTIC` 楽観ロック。
`OPTIMISTIC_FORCE_INCREMENT` バージョンのアップデートを伴う楽観ロック。
`PESSIMISTIC_FORCE_INCREMENT` バージョンのアップデートを伴う悲観書き込みロック。
`PESSIMISTIC_READ` 悲観読み込みロック。
`PESSIMISTIC_WRITE` 悲観書き込みロック。
`READ` `OPTIMISTIC`と同じ意味。
`WRITE` `OPTIMISTIC_FORCE_INCREMENT`と同じ意味。

メソッドのサマリー

すべてのメソッド staticメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static LockModeType`	`valueOf(java.lang.String name)` 指定した名前を持つこの型の列挙型定数を返します。
`static LockModeType[]`	`values()` この列挙型の定数を含む配列を宣言されている順序で返します。

クラスから継承されたメソッド java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

クラスから継承されたメソッド java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- 列挙型定数の詳細
  - READ
```
public static final LockModeType READ
```
    OPTIMISTICと同じ意味。新しいアプリケーションではOPTIMISTICが好ましい。
  - WRITE
```
public static final LockModeType WRITE
```
    OPTIMISTIC_FORCE_INCREMENTと同じ意味。新しいアプリケーションではOPTIMISTIC_FORCE_IMCREMENTが好ましい。
  - OPTIMISTIC
```
public static final LockModeType OPTIMISTIC
```
    楽観ロック。
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - OPTIMISTIC_FORCE_INCREMENT
```
public static final LockModeType OPTIMISTIC_FORCE_INCREMENT
```
    バージョンのアップデートを伴う楽観ロック。
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - PESSIMISTIC_READ
```
public static final LockModeType PESSIMISTIC_READ
```
    悲観読み込みロック。
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - PESSIMISTIC_WRITE
```
public static final LockModeType PESSIMISTIC_WRITE
```
    悲観書き込みロック。
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - PESSIMISTIC_FORCE_INCREMENT
```
public static final LockModeType PESSIMISTIC_FORCE_INCREMENT
```
    バージョンのアップデートを伴う悲観書き込みロック。
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - NONE
```
public static final LockModeType NONE
```
    ロックしない。
    
    導入されたバージョン:
    
    Java Persistence 2.0
- メソッドの詳細
  - values
```
public static LockModeType[] values()
```
    この列挙型の定数を含む配列を宣言されている順序で返します。このメソッドは次のようにして定数を反復するために使用できます:
```
for(LockModeType c: LockModeType.values())
  System.out.println(c);
```
    戻り値:
    
    この列挙型の定数を含む、宣言されている順序での配列
  - valueOf
```
public static LockModeType valueOf(java.lang.String name)
```
    指定した名前を持つこの型の列挙型定数を返します。文字列は、この型の列挙型定数を宣言するのに使用した識別子と正確に 一致している必要があります。 (余分な空白文字を含めることはできません。)
    
    パラメータ:
    
    name - 返される列挙型定数の名前。
    
    戻り値:
    
    指定した名前の列挙型定数
    
    例外:
    
    java.lang.IllegalArgumentException - この列挙型に、指定した名前の定数がない場合
    
    java.lang.NullPointerException - 引数がnullの場合

列挙型 LockModeType

列挙型定数のサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Enum

クラスから継承されたメソッド java.lang.Object

列挙型定数の詳細

READ

WRITE

OPTIMISTIC

OPTIMISTIC_FORCE_INCREMENT

PESSIMISTIC_READ

PESSIMISTIC_WRITE

PESSIMISTIC_FORCE_INCREMENT

NONE

メソッドの詳細

values

valueOf