org.seasar.doma

Annotation Type Domain

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

Indicates a domain class.

The domain class is the user defined type that wraps a basic value. It can be mapped to a database column.

Instantiation by constructor:

 @Domain(valueType = String.class)
 public class PhoneNumber {

     private final String value;

     public PhoneNumber(String value) {
         this.value = value;
     }

     public String getValue() {
         return value;
     }
 }
 

Instantiation by factory method:

 @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);
     }
 }
 

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<?>	valueType

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
boolean	acceptNull
java.lang.String	accessorMethod The accessor method name.
java.lang.String	factoryMethod The factory method name.

Element Detail

valueType

public abstract java.lang.Class<?> valueType

Returns:

the value type that is wrapped by the domain class.

factoryMethod

public abstract java.lang.String factoryMethod

The factory method name.

The factory method that accepts the wrapped value as an argument.

The default value "new" means constructor usage.

Returns:

the method name

Default:

"new"

accessorMethod

public abstract java.lang.String accessorMethod

The accessor method name.

The accessor method returns the wrapped value.

Returns:

the method name

Default:

"getValue"

acceptNull

public abstract boolean acceptNull

Returns:

whether the constructor or the factory method accepts null as an argument.

Default:

false