OneToOne (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

Child<T>, OrmOneToOneCommType<T,OneToOne<T>,PrimaryKeyJoinColumn<OneToOne<T>>,JoinColumn<OneToOne<T>>,JoinTable<OneToOne<T>>,CascadeType<OneToOne<T>>>
```
public interface OneToOne<T>
extends Child<T>, OrmOneToOneCommType<T,OneToOne<T>,PrimaryKeyJoinColumn<OneToOne<T>>,JoinColumn<OneToOne<T>>,JoinTable<OneToOne<T>>,CascadeType<OneToOne<T>>>
```
This interface defines the contract for the one-to-one xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JoinColumn<OneToOne<T>>`	`createJoinColumn()` Creates a new `join-column` element
`PrimaryKeyJoinColumn<OneToOne<T>>`	`createPrimaryKeyJoinColumn()` Creates a new `primary-key-join-column` element
`OneToOne<T>`	`fetch(FetchType fetch)` Sets the `fetch` attribute
`OneToOne<T>`	`fetch(String fetch)` Sets the `fetch` attribute
`List<JoinColumn<OneToOne<T>>>`	`getAllJoinColumn()` Returns all `join-column` elements
`List<PrimaryKeyJoinColumn<OneToOne<T>>>`	`getAllPrimaryKeyJoinColumn()` Returns all `primary-key-join-column` elements
`FetchType`	`getFetch()` Returns the `fetch` attribute
`String`	`getFetchAsString()` Returns the `fetch` attribute
`String`	`getMappedBy()` Returns the `mapped-by` attribute
`String`	`getName()` Returns the `name` attribute
`CascadeType<OneToOne<T>>`	`getOrCreateCascade()` If not already created, a new `cascade` element with the given value will be created.
`JoinColumn<OneToOne<T>>`	`getOrCreateJoinColumn()` If not already created, a new `join-column` element will be created and returned.
`JoinTable<OneToOne<T>>`	`getOrCreateJoinTable()` If not already created, a new `join-table` element with the given value will be created.
`PrimaryKeyJoinColumn<OneToOne<T>>`	`getOrCreatePrimaryKeyJoinColumn()` If not already created, a new `primary-key-join-column` element will be created and returned.
`String`	`getTargetEntity()` Returns the `target-entity` attribute
`Boolean`	`isOptional()` Returns the `optional` attribute
`OneToOne<T>`	`mappedBy(String mappedBy)` Sets the `mapped-by` attribute
`OneToOne<T>`	`name(String name)` Sets the `name` attribute
`OneToOne<T>`	`optional(Boolean optional)` Sets the `optional` attribute
`OneToOne<T>`	`removeAllJoinColumn()` Removes all `join-column` elements
`OneToOne<T>`	`removeAllPrimaryKeyJoinColumn()` Removes all `primary-key-join-column` elements
`OneToOne<T>`	`removeCascade()` Removes the `cascade` element
`OneToOne<T>`	`removeFetch()` Removes the `fetch` attribute
`OneToOne<T>`	`removeJoinTable()` Removes the `join-table` element
`OneToOne<T>`	`removeMappedBy()` Removes the `mapped-by` attribute
`OneToOne<T>`	`removeName()` Removes the `name` attribute
`OneToOne<T>`	`removeOptional()` Removes the `optional` attribute
`OneToOne<T>`	`removeTargetEntity()` Removes the `target-entity` attribute
`OneToOne<T>`	`targetEntity(String targetEntity)` Sets the `target-entity` attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - getOrCreatePrimaryKeyJoinColumn
```
PrimaryKeyJoinColumn<OneToOne<T>> getOrCreatePrimaryKeyJoinColumn()
```
    If not already created, a new primary-key-join-column element will be created and returned. Otherwise, the first existing primary-key-join-column element will be returned.
    
    Returns:
    
    the instance defined for the element primary-key-join-column
  - createPrimaryKeyJoinColumn
```
PrimaryKeyJoinColumn<OneToOne<T>> createPrimaryKeyJoinColumn()
```
    Creates a new primary-key-join-column element
    
    Returns:
    
    the new created instance of PrimaryKeyJoinColumn>
  - getAllPrimaryKeyJoinColumn
```
List<PrimaryKeyJoinColumn<OneToOne<T>>> getAllPrimaryKeyJoinColumn()
```
    Returns all primary-key-join-column elements
    
    Returns:
    
    list of primary-key-join-column
  - removeAllPrimaryKeyJoinColumn
```
OneToOne<T> removeAllPrimaryKeyJoinColumn()
```
    Removes all primary-key-join-column elements
    
    Returns:
    
    the current instance of PrimaryKeyJoinColumn>
  - getOrCreateJoinColumn
```
JoinColumn<OneToOne<T>> getOrCreateJoinColumn()
```
    If not already created, a new join-column element will be created and returned. Otherwise, the first existing join-column element will be returned.
    
    Returns:
    
    the instance defined for the element join-column
  - createJoinColumn
```
JoinColumn<OneToOne<T>> createJoinColumn()
```
    Creates a new join-column element
    
    Returns:
    
    the new created instance of JoinColumn>
  - getAllJoinColumn
```
List<JoinColumn<OneToOne<T>>> getAllJoinColumn()
```
    Returns all join-column elements
    
    Returns:
    
    list of join-column
  - removeAllJoinColumn
```
OneToOne<T> removeAllJoinColumn()
```
    Removes all join-column elements
    
    Returns:
    
    the current instance of JoinColumn>
  - getOrCreateJoinTable
```
JoinTable<OneToOne<T>> getOrCreateJoinTable()
```
    If not already created, a new join-table element with the given value will be created. Otherwise, the existing join-table element will be returned.
    
    Returns:
    
    a new or existing instance of JoinTable>
  - removeJoinTable
```
OneToOne<T> removeJoinTable()
```
    Removes the join-table element
    
    Returns:
    
    the current instance of OneToOne
  - getOrCreateCascade
```
CascadeType<OneToOne<T>> getOrCreateCascade()
```
    If not already created, a new cascade element with the given value will be created. Otherwise, the existing cascade element will be returned.
    
    Returns:
    
    a new or existing instance of CascadeType>
  - removeCascade
```
OneToOne<T> removeCascade()
```
    Removes the cascade element
    
    Returns:
    
    the current instance of OneToOne
  - name
```
OneToOne<T> name(String name)
```
    Sets the name attribute
    
    Parameters:
    
    name - the value for the attribute name
    
    Returns:
    
    the current instance of OneToOne
  - getName
```
String getName()
```
    Returns the name attribute
    
    Returns:
    
    the value defined for the attribute name
  - removeName
```
OneToOne<T> removeName()
```
    Removes the name attribute
    
    Returns:
    
    the current instance of OneToOne
  - targetEntity
```
OneToOne<T> targetEntity(String targetEntity)
```
    Sets the target-entity attribute
    
    Parameters:
    
    targetEntity - the value for the attribute target-entity
    
    Returns:
    
    the current instance of OneToOne
  - getTargetEntity
```
String getTargetEntity()
```
    Returns the target-entity attribute
    
    Returns:
    
    the value defined for the attribute target-entity
  - removeTargetEntity
```
OneToOne<T> removeTargetEntity()
```
    Removes the target-entity attribute
    
    Returns:
    
    the current instance of OneToOne
  - fetch
```
OneToOne<T> fetch(FetchType fetch)
```
    Sets the fetch attribute
    
    Parameters:
    
    fetch - the value for the attribute fetch
    
    Returns:
    
    the current instance of OneToOne
  - fetch
```
OneToOne<T> fetch(String fetch)
```
    Sets the fetch attribute
    
    Parameters:
    
    fetch - the value for the attribute fetch
    
    Returns:
    
    the current instance of OneToOne
  - getFetch
```
FetchType getFetch()
```
    Returns the fetch attribute
    
    Returns:
    
    the value defined for the attribute fetch
  - getFetchAsString
```
String getFetchAsString()
```
    Returns the fetch attribute
    
    Returns:
    
    the value found for the element fetch
  - removeFetch
```
OneToOne<T> removeFetch()
```
    Removes the fetch attribute
    
    Returns:
    
    the current instance of OneToOne
  - optional
```
OneToOne<T> optional(Boolean optional)
```
    Sets the optional attribute
    
    Parameters:
    
    optional - the value for the attribute optional
    
    Returns:
    
    the current instance of OneToOne
  - isOptional
```
Boolean isOptional()
```
    Returns the optional attribute
    
    Returns:
    
    the value defined for the attribute optional
  - removeOptional
```
OneToOne<T> removeOptional()
```
    Removes the optional attribute
    
    Returns:
    
    the current instance of OneToOne
  - mappedBy
```
OneToOne<T> mappedBy(String mappedBy)
```
    Sets the mapped-by attribute
    
    Parameters:
    
    mappedBy - the value for the attribute mapped-by
    
    Returns:
    
    the current instance of OneToOne
  - getMappedBy
```
String getMappedBy()
```
    Returns the mapped-by attribute
    
    Returns:
    
    the value defined for the attribute mapped-by
  - removeMappedBy
```
OneToOne<T> removeMappedBy()
```
    Removes the mapped-by attribute
    
    Returns:
    
    the current instance of OneToOne

Interface OneToOne<T>

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

Method Detail

getOrCreatePrimaryKeyJoinColumn

createPrimaryKeyJoinColumn

getAllPrimaryKeyJoinColumn

removeAllPrimaryKeyJoinColumn

getOrCreateJoinColumn

createJoinColumn

getAllJoinColumn

removeAllJoinColumn

getOrCreateJoinTable

removeJoinTable

getOrCreateCascade

removeCascade

name

getName

removeName

targetEntity

getTargetEntity

removeTargetEntity

fetch

fetch

getFetch

getFetchAsString

removeFetch

optional

isOptional

removeOptional

mappedBy

getMappedBy

removeMappedBy