blob: 88dda51397c328a081bdcbf12b6bf13f3022fd30 [file] [log] [blame]
@Target({ElementType.FIELD, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Column
{
/**
* Name of the column.
* @return the name of the column
*/
String name() default "";
/**
* Target column for this column in the other table when part of a
* foreign key relation.
* @return the target column in the other table for this column
* when part of a foreign key relation.
*/
String target() default "";
/**
* Target member in the other class or interface for this column
* when part of a bidirectional relation.
* @return the target member for this column when part of
* a bidirectional relation.
*/
String targetMember() default "";
/**
* JDBC Type for this column.
* @return JDBC type for this column
*/
String jdbcType() default "";
/**
* SQL Type for this column.
* @return SQL type for this column
*/
String sqlType() default "";
/**
* Maximum length of data stored in this column.
* @return the maximum length of data stored in this column
*/
int length() default -1;
/**
* Scale for the column when handling floating point values.
* @return the scale for the column when handling floating point values
*/
int scale() default -1;
/**
* Whether the column allows null values to be inserted.
* @return whether the column allows null values to be inserted
*/
String allowsNull() default "";
/**
* Default value for this column.
* @return the default value for this column
*/
String defaultValue() default "";
/**
* Value to be inserted when this is an "unmapped" column
* @return the value to be inserted when this is an "unmapped" column
*/
String insertValue() default "";
/** Vendor extensions.
* @return the vendor extensions
*/
Extension[] extensions() default {};
}