Package io.github.joselion.springr2dbcrelationships.annotations

Annotation Interface OneToOne

@Documented
@Value("null")
@Retention(RUNTIME)
@Target({FIELD,PARAMETER,ANNOTATION_TYPE})
public @interface OneToOne

Marks a field to have a one-to-one relationship.

This annotation also adds the @Transient and @Value("null") annotations to the field.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
boolean	keepOrphan	Whether the orphan entity is preserved or not.
String	mappedBy	Specifies the name of the "foreign key" column in the associated table.
boolean	readonly	Whether the associated entity are read-only or not, meaning it's never persisted or linked.

Element Details

keepOrphan

boolean keepOrphan

Whether the orphan entity is preserved or not. Defaults to false.

Usually, one-to-one relationships have a parent-child configuration, meaning the child needs to have the parent assigned to it. By default, the annotation will delete the associated entity when it becomes an orphan or the child is no longer assigned to the parent. You can prevent this behavior by setting this option to true, in which case the annotation will only remove the link of the orphan entity with the parent.

Returns:

true if orphan entities should be presereved, false otherwise

Default:

false

mappedBy

String mappedBy

Specifies the name of the "foreign key" column in the associated table. This is optional because the annotation can infer the "foreign key" column name in two different ways:

1. The column's name matches the parent table's name followed by an _id suffix.

2. The column's name matches the name of the annotated field followed by an _id suffix.

For example, given a parent table phone, a child table details, and the annotated field @OneToOne Details details;. The "foreign key" column of the details table will be inferred as either phone_id using option (1) or as details_id using option (2).

Returns:

the "foreign key" column name in the associated table

Default:

""

readonly

boolean readonly

Whether the associated entity are read-only or not, meaning it's never persisted or linked. Defaults to false.

Returns:

true if the associated entity is read-only, false otherwise

Default:

false