org.jboss.shrinkwrap.descriptor.api.persistence10
Interface PersistenceUnit<T>

All Superinterfaces:

Child<T>

public interface PersistenceUnit<T>
extends Child<T>

This interface defines the contract for the persistence-unit xsd type

Since:

Generation date :2012-05-09T23:45:03.702-07:00

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

PersistenceUnit<T>	clazz(String... values) Creates for all String objects representing class elements, a new class element
PersistenceUnit<T>	description(String description) Sets the description element
PersistenceUnit<T>	excludeUnlistedClasses(Boolean excludeUnlistedClasses) Sets the exclude-unlisted-classes element
List<String>	getAllClazz() Returns all class elements
List<String>	getAllJarFile() Returns all jar-file elements
List<String>	getAllMappingFile() Returns all mapping-file elements
String	getDescription() Returns the description element
String	getJtaDataSource() Returns the jta-data-source element
String	getName() Returns the name attribute
String	getNonJtaDataSource() Returns the non-jta-data-source element
Properties<PersistenceUnit<T>>	getOrCreateProperties() If not already created, a new properties element with the given value will be created.
String	getProvider() Returns the provider element
PersistenceUnitTransactionType	getTransactionType() Returns the transaction-type attribute
String	getTransactionTypeAsString() Returns the transaction-type attribute
Boolean	isExcludeUnlistedClasses() Returns the exclude-unlisted-classes element
PersistenceUnit<T>	jarFile(String... values) Creates for all String objects representing jar-file elements, a new jar-file element
PersistenceUnit<T>	jtaDataSource(String jtaDataSource) Sets the jta-data-source element
PersistenceUnit<T>	mappingFile(String... values) Creates for all String objects representing mapping-file elements, a new mapping-file element
PersistenceUnit<T>	name(String name) Sets the name attribute
PersistenceUnit<T>	nonJtaDataSource(String nonJtaDataSource) Sets the non-jta-data-source element
PersistenceUnit<T>	provider(String provider) Sets the provider element
PersistenceUnit<T>	removeAllClazz() Removes the class element
PersistenceUnit<T>	removeAllJarFile() Removes the jar-file element
PersistenceUnit<T>	removeAllMappingFile() Removes the mapping-file element
PersistenceUnit<T>	removeDescription() Removes the description element
PersistenceUnit<T>	removeExcludeUnlistedClasses() Removes the exclude-unlisted-classes element
PersistenceUnit<T>	removeJtaDataSource() Removes the jta-data-source element
PersistenceUnit<T>	removeName() Removes the name attribute
PersistenceUnit<T>	removeNonJtaDataSource() Removes the non-jta-data-source element
PersistenceUnit<T>	removeProperties() Removes the properties element
PersistenceUnit<T>	removeProvider() Removes the provider element
PersistenceUnit<T>	removeTransactionType() Removes the transaction-type attribute
PersistenceUnit<T>	transactionType(PersistenceUnitTransactionType transactionType) Sets the transaction-type attribute
PersistenceUnit<T>	transactionType(String transactionType) Sets the transaction-type attribute

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

up

Method Detail

description

PersistenceUnit<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of PersistenceUnit

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

PersistenceUnit<T> removeDescription()

Removes the description element

Returns:

the current instance of PersistenceUnit

provider

PersistenceUnit<T> provider(String provider)

Sets the provider element

Parameters:

provider - the value for the element provider

Returns:

the current instance of PersistenceUnit

getProvider

String getProvider()

Returns the provider element

Returns:

the node defined for the element provider

removeProvider

PersistenceUnit<T> removeProvider()

Removes the provider element

Returns:

the current instance of PersistenceUnit

jtaDataSource

PersistenceUnit<T> jtaDataSource(String jtaDataSource)

Sets the jta-data-source element

Parameters:

jtaDataSource - the value for the element jta-data-source

Returns:

the current instance of PersistenceUnit

getJtaDataSource

String getJtaDataSource()

Returns the jta-data-source element

Returns:

the node defined for the element jta-data-source

removeJtaDataSource

PersistenceUnit<T> removeJtaDataSource()

Removes the jta-data-source element

Returns:

the current instance of PersistenceUnit

nonJtaDataSource

PersistenceUnit<T> nonJtaDataSource(String nonJtaDataSource)

Sets the non-jta-data-source element

Parameters:

nonJtaDataSource - the value for the element non-jta-data-source

Returns:

the current instance of PersistenceUnit

getNonJtaDataSource

String getNonJtaDataSource()

Returns the non-jta-data-source element

Returns:

the node defined for the element non-jta-data-source

removeNonJtaDataSource

PersistenceUnit<T> removeNonJtaDataSource()

Removes the non-jta-data-source element

Returns:

the current instance of PersistenceUnit

mappingFile

PersistenceUnit<T> mappingFile(String... values)

Creates for all String objects representing mapping-file elements, a new mapping-file element

Parameters:

values - list of mapping-file objects

Returns:

the current instance of PersistenceUnit

getAllMappingFile

List<String> getAllMappingFile()

Returns all mapping-file elements

Returns:

list of mapping-file

removeAllMappingFile

PersistenceUnit<T> removeAllMappingFile()

Removes the mapping-file element

Returns:

the current instance of PersistenceUnit

jarFile

PersistenceUnit<T> jarFile(String... values)

Creates for all String objects representing jar-file elements, a new jar-file element

Parameters:

values - list of jar-file objects

Returns:

the current instance of PersistenceUnit

getAllJarFile

List<String> getAllJarFile()

Returns all jar-file elements

Returns:

list of jar-file

removeAllJarFile

PersistenceUnit<T> removeAllJarFile()

Removes the jar-file element

Returns:

the current instance of PersistenceUnit

clazz

PersistenceUnit<T> clazz(String... values)

Creates for all String objects representing class elements, a new class element

Parameters:

values - list of class objects

Returns:

the current instance of PersistenceUnit

getAllClazz

List<String> getAllClazz()

Returns all class elements

Returns:

list of class

removeAllClazz

PersistenceUnit<T> removeAllClazz()

Removes the class element

Returns:

the current instance of PersistenceUnit

excludeUnlistedClasses

PersistenceUnit<T> excludeUnlistedClasses(Boolean excludeUnlistedClasses)

Sets the exclude-unlisted-classes element

Parameters:

excludeUnlistedClasses - the value for the element exclude-unlisted-classes

Returns:

the current instance of PersistenceUnit

isExcludeUnlistedClasses

Boolean isExcludeUnlistedClasses()

Returns the exclude-unlisted-classes element

Returns:

the node defined for the element exclude-unlisted-classes

removeExcludeUnlistedClasses

PersistenceUnit<T> removeExcludeUnlistedClasses()

Removes the exclude-unlisted-classes element

Returns:

the current instance of PersistenceUnit

getOrCreateProperties

Properties<PersistenceUnit<T>> getOrCreateProperties()

If not already created, a new properties element with the given value will be created. Otherwise, the existing properties element will be returned.

Returns:

a new or existing instance of Properties>

removeProperties

PersistenceUnit<T> removeProperties()

Removes the properties element

Returns:

the current instance of PersistenceUnit

name

PersistenceUnit<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of PersistenceUnit

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

PersistenceUnit<T> removeName()

Removes the name attribute

Returns:

the current instance of PersistenceUnit

transactionType

PersistenceUnit<T> transactionType(PersistenceUnitTransactionType transactionType)

Sets the transaction-type attribute

Parameters:

transactionType - the value for the attribute transaction-type

Returns:

the current instance of PersistenceUnit

transactionType

PersistenceUnit<T> transactionType(String transactionType)

Sets the transaction-type attribute

Parameters:

transactionType - the value for the attribute transaction-type

Returns:

the current instance of PersistenceUnit

getTransactionType

PersistenceUnitTransactionType getTransactionType()

Returns the transaction-type attribute

Returns:

the value defined for the attribute transaction-type

getTransactionTypeAsString

String getTransactionTypeAsString()

Returns the transaction-type attribute

Returns:

the value found for the element transaction-type

removeTransactionType

PersistenceUnit<T> removeTransactionType()

Removes the transaction-type attribute

Returns:

the current instance of PersistenceUnit