OneToOne (hibernate-jpamodelgen JavaDocs)

java.lang.Object
- org.hibernate.jpamodelgen.xml.jaxb.OneToOne

```
public class OneToOne
extends Object
```
@Target({METHOD, FIELD}) @Retention(RUNTIME) public @interface OneToOne { Class targetEntity() default void.class; CascadeType[] cascade() default {}; FetchType fetch() default EAGER; boolean optional() default true; String mappedBy() default ""; boolean orphanRemoval() default false; }

Java class for one-to-one complex type.

The following schema fragment specifies the expected content contained within this class.

<pre> <complexType name="one-to-one"> <complexContent> <restriction base="{http://www.w3.org/2001/XMLSchema}anyType"> <sequence> <choice> <sequence> <element name="primary-key-join-column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}primary-key-join-column" maxOccurs="unbounded" minOccurs="0"/> <element name="primary-key-foreign-key" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}foreign-key" minOccurs="0"/> </sequence> <sequence> <element name="join-column" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}join-column" maxOccurs="unbounded" minOccurs="0"/> <element name="foreign-key" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}foreign-key" minOccurs="0"/> </sequence> <element name="join-table" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}join-table" minOccurs="0"/> </choice> <element name="cascade" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}cascade-type" minOccurs="0"/> </sequence> <attribute name="name" use="required" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="target-entity" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="fetch" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}fetch-type" /> <attribute name="optional" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="access" type="{http://xmlns.jcp.org/xml/ns/persistence/orm}access-type" /> <attribute name="mapped-by" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="orphan-removal" type="{http://www.w3.org/2001/XMLSchema}boolean" /> <attribute name="maps-id" type="{http://www.w3.org/2001/XMLSchema}string" /> <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}boolean" /> </restriction> </complexContent> </complexType> </pre>

Field Summary

Fields
Modifier and Type	Field and Description
`protected AccessType`	`access`
`protected CascadeType`	`cascade`
`protected FetchType`	`fetch`
`protected ForeignKey`	`foreignKey`
`protected Boolean`	`id`
`protected List<JoinColumn>`	`joinColumn`
`protected JoinTable`	`joinTable`
`protected String`	`mappedBy`
`protected String`	`mapsId`
`protected String`	`name`
`protected Boolean`	`optional`
`protected Boolean`	`orphanRemoval`
`protected ForeignKey`	`primaryKeyForeignKey`
`protected List<PrimaryKeyJoinColumn>`	`primaryKeyJoinColumn`
`protected String`	`targetEntity`

Constructor Summary

Constructors
Constructor and Description

OneToOne()

Constructors
Constructor and Description
`OneToOne()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessType`	`getAccess()` Gets the value of the access property.
`CascadeType`	`getCascade()` Gets the value of the cascade property.
`FetchType`	`getFetch()` Gets the value of the fetch property.
`ForeignKey`	`getForeignKey()` Gets the value of the foreignKey property.
`List<JoinColumn>`	`getJoinColumn()` Gets the value of the joinColumn property.
`JoinTable`	`getJoinTable()` Gets the value of the joinTable property.
`String`	`getMappedBy()` Gets the value of the mappedBy property.
`String`	`getMapsId()` Gets the value of the mapsId property.
`String`	`getName()` Gets the value of the name property.
`ForeignKey`	`getPrimaryKeyForeignKey()` Gets the value of the primaryKeyForeignKey property.
`List<PrimaryKeyJoinColumn>`	`getPrimaryKeyJoinColumn()` Gets the value of the primaryKeyJoinColumn property.
`String`	`getTargetEntity()` Gets the value of the targetEntity property.
`Boolean`	`isId()` Gets the value of the id property.
`Boolean`	`isOptional()` Gets the value of the optional property.
`Boolean`	`isOrphanRemoval()` Gets the value of the orphanRemoval property.
`void`	`setAccess(AccessType value)` Sets the value of the access property.
`void`	`setCascade(CascadeType value)` Sets the value of the cascade property.
`void`	`setFetch(FetchType value)` Sets the value of the fetch property.
`void`	`setForeignKey(ForeignKey value)` Sets the value of the foreignKey property.
`void`	`setId(Boolean value)` Sets the value of the id property.
`void`	`setJoinTable(JoinTable value)` Sets the value of the joinTable property.
`void`	`setMappedBy(String value)` Sets the value of the mappedBy property.
`void`	`setMapsId(String value)` Sets the value of the mapsId property.
`void`	`setName(String value)` Sets the value of the name property.
`void`	`setOptional(Boolean value)` Sets the value of the optional property.
`void`	`setOrphanRemoval(Boolean value)` Sets the value of the orphanRemoval property.
`void`	`setPrimaryKeyForeignKey(ForeignKey value)` Sets the value of the primaryKeyForeignKey property.
`void`	`setTargetEntity(String value)` Sets the value of the targetEntity property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
 - primaryKeyJoinColumn
```
protected List<PrimaryKeyJoinColumn> primaryKeyJoinColumn
```
 - primaryKeyForeignKey
```
protected ForeignKey primaryKeyForeignKey
```
 - joinColumn
```
protected List<JoinColumn> joinColumn
```
 - foreignKey
```
protected ForeignKey foreignKey
```
 - joinTable
```
protected JoinTable joinTable
```
 - cascade
```
protected CascadeType cascade
```
 - name
```
protected String name
```
 - targetEntity
```
protected String targetEntity
```
 - fetch
```
protected FetchType fetch
```
 - optional
```
protected Boolean optional
```
 - access
```
protected AccessType access
```
 - mappedBy
```
protected String mappedBy
```
 - orphanRemoval
```
protected Boolean orphanRemoval
```
 - mapsId
```
protected String mapsId
```
 - id
```
protected Boolean id
```
- Constructor Detail
 - OneToOne
```
public OneToOne()
```
- Method Detail
 - getPrimaryKeyJoinColumn
```
public List<PrimaryKeyJoinColumn> getPrimaryKeyJoinColumn()
```
 Gets the value of the primaryKeyJoinColumn property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the primaryKeyJoinColumn property.
 
 For example, to add a new item, do as follows: <pre> getPrimaryKeyJoinColumn().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list PrimaryKeyJoinColumn
 - getPrimaryKeyForeignKey
```
public ForeignKey getPrimaryKeyForeignKey()
```
 Gets the value of the primaryKeyForeignKey property.
 
 Returns:
 
 possible object is ForeignKey
 - setPrimaryKeyForeignKey
```
public void setPrimaryKeyForeignKey(ForeignKey value)
```
 Sets the value of the primaryKeyForeignKey property.
 
 Parameters:
 
 value - allowed object is ForeignKey
 - getJoinColumn
```
public List<JoinColumn> getJoinColumn()
```
 Gets the value of the joinColumn property.
 
 This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a <CODE>set</CODE> method for the joinColumn property.
 
 For example, to add a new item, do as follows: <pre> getJoinColumn().add(newItem); </pre>
 
 Objects of the following type(s) are allowed in the list JoinColumn
 - getForeignKey
```
public ForeignKey getForeignKey()
```
 Gets the value of the foreignKey property.
 
 Returns:
 
 possible object is ForeignKey
 - setForeignKey
```
public void setForeignKey(ForeignKey value)
```
 Sets the value of the foreignKey property.
 
 Parameters:
 
 value - allowed object is ForeignKey
 - getJoinTable
```
public JoinTable getJoinTable()
```
 Gets the value of the joinTable property.
 
 Returns:
 
 possible object is JoinTable
 - setJoinTable
```
public void setJoinTable(JoinTable value)
```
 Sets the value of the joinTable property.
 
 Parameters:
 
 value - allowed object is JoinTable
 - getCascade
```
public CascadeType getCascade()
```
 Gets the value of the cascade property.
 
 Returns:
 
 possible object is CascadeType
 - setCascade
```
public void setCascade(CascadeType value)
```
 Sets the value of the cascade property.
 
 Parameters:
 
 value - allowed object is CascadeType
 - getName
```
public String getName()
```
 Gets the value of the name property.
 
 Returns:
 
 possible object is String
 - setName
```
public void setName(String value)
```
 Sets the value of the name property.
 
 Parameters:
 
 value - allowed object is String
 - getTargetEntity
```
public String getTargetEntity()
```
 Gets the value of the targetEntity property.
 
 Returns:
 
 possible object is String
 - setTargetEntity
```
public void setTargetEntity(String value)
```
 Sets the value of the targetEntity property.
 
 Parameters:
 
 value - allowed object is String
 - getFetch
```
public FetchType getFetch()
```
 Gets the value of the fetch property.
 
 Returns:
 
 possible object is FetchType
 - setFetch
```
public void setFetch(FetchType value)
```
 Sets the value of the fetch property.
 
 Parameters:
 
 value - allowed object is FetchType
 - isOptional
```
public Boolean isOptional()
```
 Gets the value of the optional property.
 
 Returns:
 
 possible object is Boolean
 - setOptional
```
public void setOptional(Boolean value)
```
 Sets the value of the optional property.
 
 Parameters:
 
 value - allowed object is Boolean
 - getAccess
```
public AccessType getAccess()
```
 Gets the value of the access property.
 
 Returns:
 
 possible object is AccessType
 - setAccess
```
public void setAccess(AccessType value)
```
 Sets the value of the access property.
 
 Parameters:
 
 value - allowed object is AccessType
 - getMappedBy
```
public String getMappedBy()
```
 Gets the value of the mappedBy property.
 
 Returns:
 
 possible object is String
 - setMappedBy
```
public void setMappedBy(String value)
```
 Sets the value of the mappedBy property.
 
 Parameters:
 
 value - allowed object is String
 - isOrphanRemoval
```
public Boolean isOrphanRemoval()
```
 Gets the value of the orphanRemoval property.
 
 Returns:
 
 possible object is Boolean
 - setOrphanRemoval
```
public void setOrphanRemoval(Boolean value)
```
 Sets the value of the orphanRemoval property.
 
 Parameters:
 
 value - allowed object is Boolean
 - getMapsId
```
public String getMapsId()
```
 Gets the value of the mapsId property.
 
 Returns:
 
 possible object is String
 - setMapsId
```
public void setMapsId(String value)
```
 Sets the value of the mapsId property.
 
 Parameters:
 
 value - allowed object is String
 - isId
```
public Boolean isId()
```
 Gets the value of the id property.
 
 Returns:
 
 possible object is Boolean
 - setId
```
public void setId(Boolean value)
```
 Sets the value of the id property.
 
 Parameters:
 
 value - allowed object is Boolean

Class OneToOne

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

primaryKeyJoinColumn

primaryKeyForeignKey

joinColumn

foreignKey

joinTable

cascade

name

targetEntity

fetch

optional

access

mappedBy

orphanRemoval

mapsId

id

Constructor Detail

OneToOne

Method Detail

getPrimaryKeyJoinColumn

getPrimaryKeyForeignKey

setPrimaryKeyForeignKey

getJoinColumn

getForeignKey

setForeignKey

getJoinTable

setJoinTable

getCascade

setCascade

getName

setName

getTargetEntity

setTargetEntity

getFetch

setFetch

isOptional

setOptional

getAccess

setAccess

getMappedBy

setMappedBy

isOrphanRemoval

setOrphanRemoval

getMapsId

setMapsId

isId

setId