PersistenceUnitInfo (javax.persistence-api 2.2 API)

```
public interface PersistenceUnitInfo
```
コンテナによって実装され、EntityManagerFactory作成時に永続化プロバイダによって使用されるインタフェースです。

導入されたバージョン:

Java Persistence 1.0

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`void`	`addTransformer(ClassTransformer transformer)` `getClassLoader()`メソッドによって返されたローダーによってロードされる新しいクラス定義やクラスの再定義のたびに呼び出されるプロバイダが提供するトランスフォーマーを追加します。
`boolean`	`excludeUnlistedClasses()` 永続化ユニットのルートに存在するが明示的にリスト化されていないクラスを管理対象クラスのセットに含めるかどうかを返します。
`java.lang.ClassLoader`	`getClassLoader()` クラスやリソース、開かれたURLをロードするためにプロバイダが使用するClassLoaderを返します。
`java.util.List<java.net.URL>`	`getJarFileUrls()` 永続化プロバイダが永続化ユニットの管理対象クラスを調べる必要があるjarファイルまたは展開されたjarファイルディレクトリのURLのリストを返します。
`javax.sql.DataSource`	`getJtaDataSource()` 永続化プロバイダによって使用されるJTA対応のデータソースを返します。
`java.util.List<java.lang.String>`	`getManagedClassNames()` 永続化プロバイダが管理対象クラスのセットに追加する必要があるクラスの名称のリストを返します。
`java.util.List<java.lang.String>`	`getMappingFileNames()` エンティティクラスのマッピングを決定するために永続化プロバイダがロードする必要があるマッピングファイルの名前のリストを返します。
`java.lang.ClassLoader`	`getNewTempClassLoader()` クラスやリソース、開かれたURLを一時的にロードするためにプロバイダが使用するClassLoaderを返します。
`javax.sql.DataSource`	`getNonJtaDataSource()` 永続化プロバイダがJTAトランザクションの外のデータにアクセスするために使用する非JTA対応のデータソースを返します。
`java.lang.String`	`getPersistenceProviderClassName()` 永続化プロバイダの実装クラスの完全修飾名(FQCN)を返します。
`java.lang.String`	`getPersistenceUnitName()` 永続化ユニットの名前を返します。
`java.net.URL`	`getPersistenceUnitRootUrl()` 永続化ユニットのルートであるjarファイルまたはディレクトリのURLを返します。
`java.lang.String`	`getPersistenceXMLSchemaVersion()` `persistence.xml`のスキーマバージョンを返します。
`java.util.Properties`	`getProperties()` プロパティオブジェクトを返します。
`SharedCacheMode`	`getSharedCacheMode()` プロバイダが永続化ユニットでL2キャッシュを使用する必要がある方法の仕様を返します。
`PersistenceUnitTransactionType`	`getTransactionType()` `EntityManagerFactory`によって作成されたエンティティマネージャーのトランザクションタイプを返します。
`ValidationMode`	`getValidationMode()` 永続化ユニットで永続化プロバイダが使用する検証モードを返します。

- メソッドの詳細
  - getPersistenceUnitName
```
java.lang.String getPersistenceUnitName()
```
    永続化ユニットの名前を返します。 persistence.xmlファイルのname属性に対応します。
    
    戻り値:
    
    永続化ユニットの名前
  - getPersistenceProviderClassName
```
java.lang.String getPersistenceProviderClassName()
```
    永続化プロバイダの実装クラスの完全修飾名(FQCN)を返します。 persistence.xmlファイルのprovider要素に対応します。
    
    戻り値:
    
    永続化プロバイダの実装クラスの完全修飾名(FQCN)
  - getTransactionType
```
PersistenceUnitTransactionType getTransactionType()
```
    EntityManagerFactoryによって作成されたエンティティマネージャーのトランザクションタイプを返します。トランザクションタイプはpersistence.xmlファイルのtransaction-type属性に対応します。
    
    戻り値:
    
    EntityManagerFactoryによって作成されたエンティティマネージャーのトランザクションタイプ
  - getJtaDataSource
```
javax.sql.DataSource getJtaDataSource()
```
    永続化プロバイダによって使用されるJTA対応のデータソースを返します。データソースはpersistence.xmlファイルのjta-data-source要素もしくはデプロイ時やコンテナにより提供されるものに対応します。
    
    戻り値:
    
    永続化プロバイダによって使用されるJTA対応のデータソース
  - getNonJtaDataSource
```
javax.sql.DataSource getNonJtaDataSource()
```
    永続化プロバイダがJTAトランザクションの外のデータにアクセスするために使用する非JTA対応のデータソースを返します。データソースはpersistence.xmlファイルのnon-jta-data-source要素もしくはデプロイ時やコンテナにより提供されるものに対応します。
    
    戻り値:
    
    永続化プロバイダがJTAトランザクションの外のデータにアクセスするために使用する非JTA対応のデータソース
  - getMappingFileNames
```
java.util.List<java.lang.String> getMappingFileNames()
```
    エンティティクラスのマッピングを決定するために永続化プロバイダがロードする必要があるマッピングファイルの名前のリストを返します。マッピングファイルは標準のXMLマッピング形式であり、アプリケーションクラスパスで一意の名前を持ち、リソースとして読み込み可能でなければなりません。各マッピングファイル名はpersistence.xmlファイルのmapping-file要素に対応します。
    
    戻り値:
    
    エンティティクラスのマッピングを決定するために永続化プロバイダがロードする必要があるマッピングファイルの名前のリスト
  - getJarFileUrls
```
java.util.List<java.net.URL> getJarFileUrls()
```
    永続化プロバイダが永続化ユニットの管理対象クラスを調べる必要があるjarファイルまたは展開されたjarファイルディレクトリのURLのリストを返します。各URLはpersistence.xmlファイルのjar-file要素に対応しています。 URLは、jarファイルを参照するURLまたは展開されたjarファイルを含むディレクトリ、またはjar形式のInputStreamを取得するためのその他のURLを参照するURLです。
    
    戻り値:
    
    jarファイルやディレクトリを参照するURLオブジェクトのリスト
  - getPersistenceUnitRootUrl
```
java.net.URL getPersistenceUnitRootUrl()
```
    永続化ユニットのルートであるjarファイルまたはディレクトリのURLを返します。 (永続化ユニットがWEB-INF/classesディレクトリにルートされている場合、これはそのディレクトリのURLになります。) URLは、jarファイルを参照するURLまたは展開されたjarファイルを含むディレクトリ、またはjar形式のInputStreamを取得するためのその他のURLを参照するURLです。
    
    戻り値:
    
    jarファイルやディレクトリを参照するURL
  - getManagedClassNames
```
java.util.List<java.lang.String> getManagedClassNames()
```
    永続化プロバイダが管理対象クラスのセットに追加する必要があるクラスの名称のリストを返します。各名称はpersistence.xmlの名前付きclass要素に対応しています。
    
    戻り値:
    
    永続化プロバイダが管理対象クラスのセットに追加する必要があるクラスの名前のリスト
  - excludeUnlistedClasses
```
boolean excludeUnlistedClasses()
```
    永続化ユニットのルートに存在するが明示的にリスト化されていないクラスを管理対象クラスのセットに含めるかどうかを返します。
    
    戻り値:
    
    永続化ユニットのルートに存在するが明示的にリスト化されていないクラスを管理対象クラスのセットに含めるかどうか
  - getSharedCacheMode
```
SharedCacheMode getSharedCacheMode()
```
    プロバイダが永続化ユニットでL2キャッシュを使用する必要がある方法の仕様を返します。このメソッドの結果はpersistence.xmlのshared-cache-mode要素に対応します。
    
    戻り値:
    
    プロバイダが永続化ユニットにL2キャッシュを使用する必要がある方法の仕様
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getValidationMode
```
ValidationMode getValidationMode()
```
    永続化ユニットで永続化プロバイダが使用する検証モードを返します。検証モードはpersistence.xmlのvalidation-mode要素に対応します。
    
    戻り値:
    
    永続化ユニットで永続化プロバイダが使用する検証モード
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getProperties
```
java.util.Properties getProperties()
```
    プロパティオブジェクトを返します。各プロパティはpersistence.xmlのproperty要素やコンテナによって設定されたプロパティに対応します。
    
    戻り値:
    
    プロパティオブジェクト
  - getPersistenceXMLSchemaVersion
```
java.lang.String getPersistenceXMLSchemaVersion()
```
    persistence.xmlのスキーマバージョンを返します。
    
    戻り値:
    
    persistence.xmlのスキーマバージョン
    
    導入されたバージョン:
    
    Java Persistence 2.0
  - getClassLoader
```
java.lang.ClassLoader getClassLoader()
```
    クラスやリソース、開かれたURLをロードするためにプロバイダが使用するClassLoaderを返します。
    
    戻り値:
    
    クラスやリソース、開かれたURLをロードするためにプロバイダが使用するClassLoader
  - addTransformer
```
void addTransformer(ClassTransformer transformer)
```
    getClassLoader()メソッドによって返されたローダーによってロードされる新しいクラス定義やクラスの再定義のたびに呼び出されるプロバイダが提供するトランスフォーマーを追加します。トランスフォーマーはgetNewTempClassLoader()メソッドによって返される結果には影響しません。クラスはそれらが一部である可能性のある永続化ユニットの数にかかわらず同じクラスローディングスコープ内では一度だけ変換されます。
    
    パラメータ:
    
    transformer - コンテナがクラスの(再)定義時に呼び出されるプロバイダが提供するトランスフォーマー
  - getNewTempClassLoader
```
java.lang.ClassLoader getNewTempClassLoader()
```
    クラスやリソース、開かれたURLを一時的にロードするためにプロバイダが使用するClassLoaderを返します。このローダーのスコープとクラスパスはgetClassLoader()によって返されるローダーのスコープとクラスパスと完全に同じです。このクラスローダーによってロードされたクラスはアプリケーションコンポーネントからは参照できません。プロバイダはこのClassLoaderをPersistenceProvider.createContainerEntityManagerFactory(javax.persistence.spi.PersistenceUnitInfo, java.util.Map)の呼び出し内でのみ使用できます。
    
    戻り値:
    
    現在のローダーと同じ可視性を持つ一時的なClassLoader

インタフェース PersistenceUnitInfo

メソッドのサマリー

メソッドの詳細

getPersistenceUnitName

getPersistenceProviderClassName

getTransactionType

getJtaDataSource

getNonJtaDataSource

getMappingFileNames

getJarFileUrls

getPersistenceUnitRootUrl

getManagedClassNames

excludeUnlistedClasses

getSharedCacheMode

getValidationMode

getProperties

getPersistenceXMLSchemaVersion

getClassLoader

addTransformer

getNewTempClassLoader