org.jboss.shrinkwrap.descriptor.api.orm20

Interface PersistenceUnitMetadata<T>

All Superinterfaces:

Child<T>, OrmPersistenceUnitMetadataCommType<T,PersistenceUnitMetadata<T>,PersistenceUnitDefaults<PersistenceUnitMetadata<T>>>

public interface PersistenceUnitMetadata<T>
extends Child<T>, OrmPersistenceUnitMetadataCommType<T,PersistenceUnitMetadata<T>,PersistenceUnitDefaults<PersistenceUnitMetadata<T>>>

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

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
PersistenceUnitMetadata<T>	description(String description) Sets the description element
String	getDescription() Returns the description element
PersistenceUnitDefaults<PersistenceUnitMetadata<T>>	getOrCreatePersistenceUnitDefaults() If not already created, a new persistence-unit-defaults element with the given value will be created.
Boolean	isXmlMappingMetadataComplete() Removes the xml-mapping-metadata-complete element
PersistenceUnitMetadata<T>	removeDescription() Removes the description element
PersistenceUnitMetadata<T>	removePersistenceUnitDefaults() Removes the persistence-unit-defaults element
PersistenceUnitMetadata<T>	removeXmlMappingMetadataComplete() Removes the xml-mapping-metadata-complete element
PersistenceUnitMetadata<T>	xmlMappingMetadataComplete() Sets the xml-mapping-metadata-complete element

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

up

Method Detail

description

PersistenceUnitMetadata<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of PersistenceUnitMetadata

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

PersistenceUnitMetadata<T> removeDescription()

Removes the description element

Returns:

the current instance of PersistenceUnitMetadata

xmlMappingMetadataComplete

PersistenceUnitMetadata<T> xmlMappingMetadataComplete()

Sets the xml-mapping-metadata-complete element

Returns:

the current instance of PersistenceUnitMetadata

isXmlMappingMetadataComplete

Boolean isXmlMappingMetadataComplete()

Removes the xml-mapping-metadata-complete element

Returns:

the current instance of PersistenceUnitMetadata

removeXmlMappingMetadataComplete

PersistenceUnitMetadata<T> removeXmlMappingMetadataComplete()

Removes the xml-mapping-metadata-complete element

Returns:

the current instance of PersistenceUnitMetadata

getOrCreatePersistenceUnitDefaults

PersistenceUnitDefaults<PersistenceUnitMetadata<T>> getOrCreatePersistenceUnitDefaults()

If not already created, a new persistence-unit-defaults element with the given value will be created. Otherwise, the existing persistence-unit-defaults element will be returned.

Returns:

a new or existing instance of PersistenceUnitDefaults>

removePersistenceUnitDefaults

PersistenceUnitMetadata<T> removePersistenceUnitDefaults()

Removes the persistence-unit-defaults element

Returns:

the current instance of PersistenceUnitMetadata