パッケージ jakarta.data.spi

アノテーションインターフェース EntityDefining


Jakarta Data フレームワーク内のエンティティ定義アノテーション型としてアノテーションを指定します。

EntityDefining でマークされたアノテーションは、アノテーションプロセッサー、CDI 拡張機能、Jakarta Data フレームワークの他のコンポーネントによって、エンティティ型を宣言するものとして認識されます。カスタムエンティティ定義アノテーション ( jakarta.persistence.Entity および jakarta.nosql.Entity 以外のエンティティアノテーション) を提供する Jakarta Data プロバイダおよび永続性モデルは、各カスタムエンティティ定義アノテーションにこのアノテーションを付ける必要があります。アプリケーションは、このアノテーションを直接使用してはなりません。

これにより、他の Jakarta Data プロバイダーとツールは、カスタムエンティティ定義アノテーションで宣言されたエンティティを認識して処理できるようになります。

プロバイダーによるカスタムエンティティアノテーションの定義の例:

 @EntityDefining
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface CustomEntity {
 }
 
プロバイダー定義のカスタムエンティティアノテーションの使用例:

 @CustomEntity
 public class Book {
     // Implementation details here
 }