Module org.seasar.doma.core

Package org.seasar.doma

Annotation Interface ArrayFactory

@Target(METHOD)
@Retention(RUNTIME)
public @interface ArrayFactory

Indicates a method that creates an Array instance for use with SQL array types.

The annotated method must be a member of a Dao annotated interface.

 @Dao
 public interface EmployeeDao {

     @ArrayFactory(typeName = "integer")
     Array createIntegerArray(Integer[] elements);
 }
 

The method may throw following exceptions:

• DomaNullPointerException if any of the method parameters are null
• JdbcException if a JDBC related error occurs

See Also:

• Connection.createArrayOf(String, Object[])

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	typeName	The SQL name of the type the elements of the array map to.

Element Details

typeName

String typeName

The SQL name of the type the elements of the array map to.

The value is passed as the first argument to Connection.createArrayOf(String, Object[]).

Returns:

the type name