EntityMappings (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-2 API)

All Superinterfaces:

Child<T>
```
public interface EntityMappings<T>
extends Child<T>
```
This interface defines the contract for the entity-mappings xsd type

Since:

Generation date :2016-02-06T02:26:14.572Z

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`EntityMappings<T>`	`_package(String _package)` Sets the `package` element
`EntityMappings<T>`	`access(AccessType access)` Sets the `access` element
`EntityMappings<T>`	`access(String access)` Sets the `access` element
`EntityMappings<T>`	`catalog(String catalog)` Sets the `catalog` element
`Embeddable<EntityMappings<T>>`	`createEmbeddable()` Creates a new `embeddable` element
`Entity<EntityMappings<T>>`	`createEntity()` Creates a new `entity` element
`MappedSuperclass<EntityMappings<T>>`	`createMappedSuperclass()` Creates a new `mapped-superclass` element
`NamedNativeQuery<EntityMappings<T>>`	`createNamedNativeQuery()` Creates a new `named-native-query` element
`NamedQuery<EntityMappings<T>>`	`createNamedQuery()` Creates a new `named-query` element
`SequenceGenerator<EntityMappings<T>>`	`createSequenceGenerator()` Creates a new `sequence-generator` element
`SqlResultSetMapping<EntityMappings<T>>`	`createSqlResultSetMapping()` Creates a new `sql-result-set-mapping` element
`TableGenerator<EntityMappings<T>>`	`createTableGenerator()` Creates a new `table-generator` element
`EntityMappings<T>`	`description(String description)` Sets the `description` element
`AccessType`	`getAccess()` Returns the `access` element
`String`	`getAccessAsString()` Returns the `access` element
`List<Embeddable<EntityMappings<T>>>`	`getAllEmbeddable()` Returns all `embeddable` elements
`List<Entity<EntityMappings<T>>>`	`getAllEntity()` Returns all `entity` elements
`List<MappedSuperclass<EntityMappings<T>>>`	`getAllMappedSuperclass()` Returns all `mapped-superclass` elements
`List<NamedNativeQuery<EntityMappings<T>>>`	`getAllNamedNativeQuery()` Returns all `named-native-query` elements
`List<NamedQuery<EntityMappings<T>>>`	`getAllNamedQuery()` Returns all `named-query` elements
`List<SequenceGenerator<EntityMappings<T>>>`	`getAllSequenceGenerator()` Returns all `sequence-generator` elements
`List<SqlResultSetMapping<EntityMappings<T>>>`	`getAllSqlResultSetMapping()` Returns all `sql-result-set-mapping` elements
`List<TableGenerator<EntityMappings<T>>>`	`getAllTableGenerator()` Returns all `table-generator` elements
`String`	`getCatalog()` Returns the `catalog` element
`String`	`getDescription()` Returns the `description` element
`Embeddable<EntityMappings<T>>`	`getOrCreateEmbeddable()` If not already created, a new `embeddable` element will be created and returned.
`Entity<EntityMappings<T>>`	`getOrCreateEntity()` If not already created, a new `entity` element will be created and returned.
`MappedSuperclass<EntityMappings<T>>`	`getOrCreateMappedSuperclass()` If not already created, a new `mapped-superclass` element will be created and returned.
`NamedNativeQuery<EntityMappings<T>>`	`getOrCreateNamedNativeQuery()` If not already created, a new `named-native-query` element will be created and returned.
`NamedQuery<EntityMappings<T>>`	`getOrCreateNamedQuery()` If not already created, a new `named-query` element will be created and returned.
`PersistenceUnitMetadata<EntityMappings<T>>`	`getOrCreatePersistenceUnitMetadata()` If not already created, a new `persistence-unit-metadata` element with the given value will be created.
`SequenceGenerator<EntityMappings<T>>`	`getOrCreateSequenceGenerator()` If not already created, a new `sequence-generator` element will be created and returned.
`SqlResultSetMapping<EntityMappings<T>>`	`getOrCreateSqlResultSetMapping()` If not already created, a new `sql-result-set-mapping` element will be created and returned.
`TableGenerator<EntityMappings<T>>`	`getOrCreateTableGenerator()` If not already created, a new `table-generator` element will be created and returned.
`String`	`getPackage()` Returns the `package` element
`String`	`getSchema()` Returns the `schema` element
`String`	`getVersion()` Returns the `version` attribute
`EntityMappings<T>`	`removeAccess()` Removes the `access` attribute
`EntityMappings<T>`	`removeAllEmbeddable()` Removes all `embeddable` elements
`EntityMappings<T>`	`removeAllEntity()` Removes all `entity` elements
`EntityMappings<T>`	`removeAllMappedSuperclass()` Removes all `mapped-superclass` elements
`EntityMappings<T>`	`removeAllNamedNativeQuery()` Removes all `named-native-query` elements
`EntityMappings<T>`	`removeAllNamedQuery()` Removes all `named-query` elements
`EntityMappings<T>`	`removeAllSequenceGenerator()` Removes all `sequence-generator` elements
`EntityMappings<T>`	`removeAllSqlResultSetMapping()` Removes all `sql-result-set-mapping` elements
`EntityMappings<T>`	`removeAllTableGenerator()` Removes all `table-generator` elements
`EntityMappings<T>`	`removeCatalog()` Removes the `catalog` element
`EntityMappings<T>`	`removeDescription()` Removes the `description` element
`EntityMappings<T>`	`removePackage()` Removes the `package` element
`EntityMappings<T>`	`removePersistenceUnitMetadata()` Removes the `persistence-unit-metadata` element
`EntityMappings<T>`	`removeSchema()` Removes the `schema` element
`EntityMappings<T>`	`removeVersion()` Removes the `version` attribute
`EntityMappings<T>`	`schema(String schema)` Sets the `schema` element
`EntityMappings<T>`	`version(String version)` Sets the `version` attribute

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

- Method Detail
  - description
```
EntityMappings<T> description(String description)
```
    Sets the description element
    
    Parameters:
    
    description - the value for the element description
    
    Returns:
    
    the current instance of EntityMappings
  - getDescription
```
String getDescription()
```
    Returns the description element
    
    Returns:
    
    the node defined for the element description
  - removeDescription
```
EntityMappings<T> removeDescription()
```
    Removes the description element
    
    Returns:
    
    the current instance of EntityMappings
  - getOrCreatePersistenceUnitMetadata
```
PersistenceUnitMetadata<EntityMappings<T>> getOrCreatePersistenceUnitMetadata()
```
    If not already created, a new persistence-unit-metadata element with the given value will be created. Otherwise, the existing persistence-unit-metadata element will be returned.
    
    Returns:
    
    a new or existing instance of PersistenceUnitMetadata>
  - removePersistenceUnitMetadata
```
EntityMappings<T> removePersistenceUnitMetadata()
```
    Removes the persistence-unit-metadata element
    
    Returns:
    
    the current instance of EntityMappings
  - _package
```
EntityMappings<T> _package(String _package)
```
    Sets the package element
    
    Parameters:
    
    _package - the value for the element package
    
    Returns:
    
    the current instance of EntityMappings
  - getPackage
```
String getPackage()
```
    Returns the package element
    
    Returns:
    
    the node defined for the element package
  - removePackage
```
EntityMappings<T> removePackage()
```
    Removes the package element
    
    Returns:
    
    the current instance of EntityMappings
  - schema
```
EntityMappings<T> schema(String schema)
```
    Sets the schema element
    
    Parameters:
    
    schema - the value for the element schema
    
    Returns:
    
    the current instance of EntityMappings
  - getSchema
```
String getSchema()
```
    Returns the schema element
    
    Returns:
    
    the node defined for the element schema
  - removeSchema
```
EntityMappings<T> removeSchema()
```
    Removes the schema element
    
    Returns:
    
    the current instance of EntityMappings
  - catalog
```
EntityMappings<T> catalog(String catalog)
```
    Sets the catalog element
    
    Parameters:
    
    catalog - the value for the element catalog
    
    Returns:
    
    the current instance of EntityMappings
  - getCatalog
```
String getCatalog()
```
    Returns the catalog element
    
    Returns:
    
    the node defined for the element catalog
  - removeCatalog
```
EntityMappings<T> removeCatalog()
```
    Removes the catalog element
    
    Returns:
    
    the current instance of EntityMappings
  - access
```
EntityMappings<T> access(AccessType access)
```
    Sets the access element
    
    Parameters:
    
    access - the value for the element access
    
    Returns:
    
    the current instance of EntityMappings
  - access
```
EntityMappings<T> access(String access)
```
    Sets the access element
    
    Parameters:
    
    access - the value for the element access
    
    Returns:
    
    the current instance of EntityMappings
  - getAccess
```
AccessType getAccess()
```
    Returns the access element
    
    Returns:
    
    the value found for the element access
  - getAccessAsString
```
String getAccessAsString()
```
    Returns the access element
    
    Returns:
    
    the value found for the element access
  - removeAccess
```
EntityMappings<T> removeAccess()
```
    Removes the access attribute
    
    Returns:
    
    the current instance of EntityMappings
  - getOrCreateSequenceGenerator
```
SequenceGenerator<EntityMappings<T>> getOrCreateSequenceGenerator()
```
    If not already created, a new sequence-generator element will be created and returned. Otherwise, the first existing sequence-generator element will be returned.
    
    Returns:
    
    the instance defined for the element sequence-generator
  - createSequenceGenerator
```
SequenceGenerator<EntityMappings<T>> createSequenceGenerator()
```
    Creates a new sequence-generator element
    
    Returns:
    
    the new created instance of SequenceGenerator>
  - getAllSequenceGenerator
```
List<SequenceGenerator<EntityMappings<T>>> getAllSequenceGenerator()
```
    Returns all sequence-generator elements
    
    Returns:
    
    list of sequence-generator
  - removeAllSequenceGenerator
```
EntityMappings<T> removeAllSequenceGenerator()
```
    Removes all sequence-generator elements
    
    Returns:
    
    the current instance of SequenceGenerator>
  - getOrCreateTableGenerator
```
TableGenerator<EntityMappings<T>> getOrCreateTableGenerator()
```
    If not already created, a new table-generator element will be created and returned. Otherwise, the first existing table-generator element will be returned.
    
    Returns:
    
    the instance defined for the element table-generator
  - createTableGenerator
```
TableGenerator<EntityMappings<T>> createTableGenerator()
```
    Creates a new table-generator element
    
    Returns:
    
    the new created instance of TableGenerator>
  - getAllTableGenerator
```
List<TableGenerator<EntityMappings<T>>> getAllTableGenerator()
```
    Returns all table-generator elements
    
    Returns:
    
    list of table-generator
  - removeAllTableGenerator
```
EntityMappings<T> removeAllTableGenerator()
```
    Removes all table-generator elements
    
    Returns:
    
    the current instance of TableGenerator>
  - getOrCreateNamedQuery
```
NamedQuery<EntityMappings<T>> getOrCreateNamedQuery()
```
    If not already created, a new named-query element will be created and returned. Otherwise, the first existing named-query element will be returned.
    
    Returns:
    
    the instance defined for the element named-query
  - createNamedQuery
```
NamedQuery<EntityMappings<T>> createNamedQuery()
```
    Creates a new named-query element
    
    Returns:
    
    the new created instance of NamedQuery>
  - getAllNamedQuery
```
List<NamedQuery<EntityMappings<T>>> getAllNamedQuery()
```
    Returns all named-query elements
    
    Returns:
    
    list of named-query
  - removeAllNamedQuery
```
EntityMappings<T> removeAllNamedQuery()
```
    Removes all named-query elements
    
    Returns:
    
    the current instance of NamedQuery>
  - getOrCreateNamedNativeQuery
```
NamedNativeQuery<EntityMappings<T>> getOrCreateNamedNativeQuery()
```
    If not already created, a new named-native-query element will be created and returned. Otherwise, the first existing named-native-query element will be returned.
    
    Returns:
    
    the instance defined for the element named-native-query
  - createNamedNativeQuery
```
NamedNativeQuery<EntityMappings<T>> createNamedNativeQuery()
```
    Creates a new named-native-query element
    
    Returns:
    
    the new created instance of NamedNativeQuery>
  - getAllNamedNativeQuery
```
List<NamedNativeQuery<EntityMappings<T>>> getAllNamedNativeQuery()
```
    Returns all named-native-query elements
    
    Returns:
    
    list of named-native-query
  - removeAllNamedNativeQuery
```
EntityMappings<T> removeAllNamedNativeQuery()
```
    Removes all named-native-query elements
    
    Returns:
    
    the current instance of NamedNativeQuery>
  - getOrCreateSqlResultSetMapping
```
SqlResultSetMapping<EntityMappings<T>> getOrCreateSqlResultSetMapping()
```
    If not already created, a new sql-result-set-mapping element will be created and returned. Otherwise, the first existing sql-result-set-mapping element will be returned.
    
    Returns:
    
    the instance defined for the element sql-result-set-mapping
  - createSqlResultSetMapping
```
SqlResultSetMapping<EntityMappings<T>> createSqlResultSetMapping()
```
    Creates a new sql-result-set-mapping element
    
    Returns:
    
    the new created instance of SqlResultSetMapping>
  - getAllSqlResultSetMapping
```
List<SqlResultSetMapping<EntityMappings<T>>> getAllSqlResultSetMapping()
```
    Returns all sql-result-set-mapping elements
    
    Returns:
    
    list of sql-result-set-mapping
  - removeAllSqlResultSetMapping
```
EntityMappings<T> removeAllSqlResultSetMapping()
```
    Removes all sql-result-set-mapping elements
    
    Returns:
    
    the current instance of SqlResultSetMapping>
  - getOrCreateMappedSuperclass
```
MappedSuperclass<EntityMappings<T>> getOrCreateMappedSuperclass()
```
    If not already created, a new mapped-superclass element will be created and returned. Otherwise, the first existing mapped-superclass element will be returned.
    
    Returns:
    
    the instance defined for the element mapped-superclass
  - createMappedSuperclass
```
MappedSuperclass<EntityMappings<T>> createMappedSuperclass()
```
    Creates a new mapped-superclass element
    
    Returns:
    
    the new created instance of MappedSuperclass>
  - getAllMappedSuperclass
```
List<MappedSuperclass<EntityMappings<T>>> getAllMappedSuperclass()
```
    Returns all mapped-superclass elements
    
    Returns:
    
    list of mapped-superclass
  - removeAllMappedSuperclass
```
EntityMappings<T> removeAllMappedSuperclass()
```
    Removes all mapped-superclass elements
    
    Returns:
    
    the current instance of MappedSuperclass>
  - getOrCreateEntity
```
Entity<EntityMappings<T>> getOrCreateEntity()
```
    If not already created, a new entity element will be created and returned. Otherwise, the first existing entity element will be returned.
    
    Returns:
    
    the instance defined for the element entity
  - createEntity
```
Entity<EntityMappings<T>> createEntity()
```
    Creates a new entity element
    
    Returns:
    
    the new created instance of Entity>
  - getAllEntity
```
List<Entity<EntityMappings<T>>> getAllEntity()
```
    Returns all entity elements
    
    Returns:
    
    list of entity
  - removeAllEntity
```
EntityMappings<T> removeAllEntity()
```
    Removes all entity elements
    
    Returns:
    
    the current instance of Entity>
  - getOrCreateEmbeddable
```
Embeddable<EntityMappings<T>> getOrCreateEmbeddable()
```
    If not already created, a new embeddable element will be created and returned. Otherwise, the first existing embeddable element will be returned.
    
    Returns:
    
    the instance defined for the element embeddable
  - createEmbeddable
```
Embeddable<EntityMappings<T>> createEmbeddable()
```
    Creates a new embeddable element
    
    Returns:
    
    the new created instance of Embeddable>
  - getAllEmbeddable
```
List<Embeddable<EntityMappings<T>>> getAllEmbeddable()
```
    Returns all embeddable elements
    
    Returns:
    
    list of embeddable
  - removeAllEmbeddable
```
EntityMappings<T> removeAllEmbeddable()
```
    Removes all embeddable elements
    
    Returns:
    
    the current instance of Embeddable>
  - version
```
EntityMappings<T> version(String version)
```
    Sets the version attribute
    
    Parameters:
    
    version - the value for the attribute version
    
    Returns:
    
    the current instance of EntityMappings
  - getVersion
```
String getVersion()
```
    Returns the version attribute
    
    Returns:
    
    the value defined for the attribute version
  - removeVersion
```
EntityMappings<T> removeVersion()
```
    Removes the version attribute
    
    Returns:
    
    the current instance of EntityMappings

Interface EntityMappings<T>

Method Summary

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

Method Detail

description

getDescription

removeDescription

getOrCreatePersistenceUnitMetadata

removePersistenceUnitMetadata

_package

getPackage

removePackage

schema

getSchema

removeSchema

catalog

getCatalog

removeCatalog

access

access

getAccess

getAccessAsString

removeAccess

getOrCreateSequenceGenerator

createSequenceGenerator

getAllSequenceGenerator

removeAllSequenceGenerator

getOrCreateTableGenerator

createTableGenerator

getAllTableGenerator

removeAllTableGenerator

getOrCreateNamedQuery

createNamedQuery

getAllNamedQuery

removeAllNamedQuery

getOrCreateNamedNativeQuery

createNamedNativeQuery

getAllNamedNativeQuery

removeAllNamedNativeQuery

getOrCreateSqlResultSetMapping

createSqlResultSetMapping

getAllSqlResultSetMapping

removeAllSqlResultSetMapping

getOrCreateMappedSuperclass

createMappedSuperclass

getAllMappedSuperclass

removeAllMappedSuperclass

getOrCreateEntity

createEntity

getAllEntity

removeAllEntity

getOrCreateEmbeddable

createEmbeddable

getAllEmbeddable

removeAllEmbeddable

version

getVersion

removeVersion