org.seasar.doma
注釈型 Domain

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

ドメインクラスを示します。ドメインクラスとは、カラムに対応付け可能な値クラスです。

注釈されたクラスは、 次の制約を満たす必要があります。

• トップレベルのクラスまたは列挙型である。
• valueType 要素に指定した型を引数とする非 private なコンストラクタを持ち、 factoryMethod 要素が "new" である。もしくは、factoryMethod 要素に指定した名前のstatic で非 private なメソッドを持ち、戻り値は注釈された型であり、 パラメータは valueType 要素に指定した型である。
• accessorMethod 要素に指定した名前の非 private なメソッドを持つ。このメソッドは、 valueType 要素に指定した型を戻り値とし、パラメータは受け取らない。

例1:コンストラクタで生成するケース

 @Domain(valueType = String.class)
 public class PhoneNumber {
 
     private final String value;
 
     public PhoneNumber(String value) {
         this.value = value;
     }
 
     public String getValue() {
         return value;
     }
 }
 

例2:ファクトリメソッドで生成するケース

 @Domain(valueType = String.class, factoryMethod = "of")
 public class PhoneNumber {
 
     private final String value;
 
     private PhoneNumber(String value) {
         this.value = value;
     }
 
     public String getValue() {
         return value;
     }
 
     public static PhoneNumber of(String value) {
         return new PhoneNumber(value);
     }
 }
 

作成者:

taedium

必須要素の概要

Class<?>

valueType ドメインクラスが扱う値型(基本型)。

任意要素の概要

String	accessorMethod ドメインクラスが扱う値に対するアクセッサーメソッドの名前。
String	factoryMethod ドメインクラスのファクトリメソッドの名前。

要素の詳細

valueType

public abstract Class<?> valueType

ドメインクラスが扱う値型(基本型)。

factoryMethod

public abstract String factoryMethod

ドメインクラスのファクトリメソッドの名前。

デフォルトの値である "new" はコンストラクタで生成することを意味します。

導入されたバージョン:

1.12.0

デフォルト:

"new"

accessorMethod

public abstract String accessorMethod

ドメインクラスが扱う値に対するアクセッサーメソッドの名前。

デフォルト:

"getValue"