org.seasar.doma

注釈型 Entity

@Target(value=TYPE)
 @Retention(value=RUNTIME)
public @interface Entity

エンティティクラスを示します。エンティティクラスのインスタンスは、テーブルもしくは結果セットのレコードを表現します。

例: ミュータブルなエンティティ

 @Entity
 public class Employee {
 
     @Id
     @Column(name = "ID")
     Integer id;
 
     @Column(name = "EMPLOYEE_NAME")
     String employeeName;
 
     @Version
     @Column(name = "VERSION")
     int version;
     
     ...
 }
 

例: イミュータブルなエンティティ

 @Entity(immutable = true)
 public class Employee {
 
     @Id
     @Column(name = "ID")
     final Integer id;
 
     @Column(name = "EMPLOYEE_NAME")
     final String employeeName;
 
     @Version
     @Column(name = "VERSION")
     final int version;
 
     public Employee(Integer id, String employeeName, int version) {
         this.id = id;
         this.employeeName = employeeName;
         this.version = version;
     }
     ...
 }
 

注釈されたインタフェースの実装はスレッドセーフであることを要求されません。

関連項目:

Table, Column, Id, Transient, Version, OriginalStates

任意要素の概要

任意要素

修飾子とタイプ	任意要素と説明
boolean	immutable イミュータブルかどうかを返します。
java.lang.Class<? extends EntityListener>	listener リスナーを返します。
NamingType	naming ネーミング規約を返します。

要素の詳細

listener

public abstract java.lang.Class<? extends EntityListener> listener

リスナーを返します。

この要素に値を指定しない場合、エンティティクラスが他のエンティティクラスを継承しているかどうかで採用する設定が変わります。

• 継承している場合、親エンティティクラスの設定を引き継ぎます
• 継承していない場合、デフォルトの設定を使用します

リスナーは、エンティティクラスごとに1つだけインスタンス化されます。

戻り値:

リスナー

デフォルト:

org.seasar.doma.jdbc.entity.NullEntityListener.class

naming

public abstract NamingType naming

ネーミング規約を返します。

この要素に値を指定しない場合、エンティティクラスが他のエンティティクラスを継承しているかどうかで採用する設定が変わります。

• 継承している場合、親エンティティクラスの設定を引き継ぎます
• 継承していない場合、デフォルトの設定を使用します

戻り値:

ネーミング規約

デフォルト:

org.seasar.doma.jdbc.entity.NamingType.NONE

immutable

public abstract boolean immutable

イミュータブルかどうかを返します。

この要素に値を指定しない場合、エンティティクラスが他のエンティティクラスを継承しているかどうかで採用する設定が変わります。

• 継承している場合、親エンティティクラスの設定を引き継ぎます
• 継承していない場合、デフォルトの設定を使用します

ただし、エンティティクラスの継承階層で true と false の混在はできません。

戻り値:

イミュータブルの場合 true

導入されたバージョン:

1.34.0

デフォルト:

false