org.jboss.shrinkwrap.descriptor.api.orm21

Interface Embedded<T>

All Superinterfaces:

Child<T>, OrmEmbeddedCommType<T,Embedded<T>,AttributeOverride<Embedded<T>>>

public interface Embedded<T>
extends Child<T>, OrmEmbeddedCommType<T,Embedded<T>,AttributeOverride<Embedded<T>>>

This interface defines the contract for the embedded xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

Modifier and Type	Method and Description
Embedded<T>	access(AccessType access) Sets the access attribute
Embedded<T>	access(String access) Sets the access attribute
AssociationOverride<Embedded<T>>	createAssociationOverride() Creates a new association-override element
AttributeOverride<Embedded<T>>	createAttributeOverride() Creates a new attribute-override element
Convert<Embedded<T>>	createConvert() Creates a new convert element
AccessType	getAccess() Returns the access attribute
String	getAccessAsString() Returns the access attribute
List<AssociationOverride<Embedded<T>>>	getAllAssociationOverride() Returns all association-override elements
List<AttributeOverride<Embedded<T>>>	getAllAttributeOverride() Returns all attribute-override elements
List<Convert<Embedded<T>>>	getAllConvert() Returns all convert elements
String	getName() Returns the name attribute
AssociationOverride<Embedded<T>>	getOrCreateAssociationOverride() If not already created, a new association-override element will be created and returned.
AttributeOverride<Embedded<T>>	getOrCreateAttributeOverride() If not already created, a new attribute-override element will be created and returned.
Convert<Embedded<T>>	getOrCreateConvert() If not already created, a new convert element will be created and returned.
Embedded<T>	name(String name) Sets the name attribute
Embedded<T>	removeAccess() Removes the access attribute
Embedded<T>	removeAllAssociationOverride() Removes all association-override elements
Embedded<T>	removeAllAttributeOverride() Removes all attribute-override elements
Embedded<T>	removeAllConvert() Removes all convert elements
Embedded<T>	removeName() Removes the name attribute

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

up

Method Detail

getOrCreateAttributeOverride

AttributeOverride<Embedded<T>> getOrCreateAttributeOverride()

If not already created, a new attribute-override element will be created and returned. Otherwise, the first existing attribute-override element will be returned.

Returns:

the instance defined for the element attribute-override

createAttributeOverride

AttributeOverride<Embedded<T>> createAttributeOverride()

Creates a new attribute-override element

Returns:

the new created instance of AttributeOverride>

getAllAttributeOverride

List<AttributeOverride<Embedded<T>>> getAllAttributeOverride()

Returns all attribute-override elements

Returns:

list of attribute-override

removeAllAttributeOverride

Embedded<T> removeAllAttributeOverride()

Removes all attribute-override elements

Returns:

the current instance of AttributeOverride>

getOrCreateAssociationOverride

AssociationOverride<Embedded<T>> getOrCreateAssociationOverride()

If not already created, a new association-override element will be created and returned. Otherwise, the first existing association-override element will be returned.

Returns:

the instance defined for the element association-override

createAssociationOverride

AssociationOverride<Embedded<T>> createAssociationOverride()

Creates a new association-override element

Returns:

the new created instance of AssociationOverride>

getAllAssociationOverride

List<AssociationOverride<Embedded<T>>> getAllAssociationOverride()

Returns all association-override elements

Returns:

list of association-override

removeAllAssociationOverride

Embedded<T> removeAllAssociationOverride()

Removes all association-override elements

Returns:

the current instance of AssociationOverride>

getOrCreateConvert

Convert<Embedded<T>> getOrCreateConvert()

If not already created, a new convert element will be created and returned. Otherwise, the first existing convert element will be returned.

Returns:

the instance defined for the element convert

createConvert

Convert<Embedded<T>> createConvert()

Creates a new convert element

Returns:

the new created instance of Convert>

getAllConvert

List<Convert<Embedded<T>>> getAllConvert()

Returns all convert elements

Returns:

list of convert

removeAllConvert

Embedded<T> removeAllConvert()

Removes all convert elements

Returns:

the current instance of Convert>

name

Embedded<T> name(String name)

Sets the name attribute

Parameters:

name - the value for the attribute name

Returns:

the current instance of Embedded

getName

String getName()

Returns the name attribute

Returns:

the value defined for the attribute name

removeName

Embedded<T> removeName()

Removes the name attribute

Returns:

the current instance of Embedded

access

Embedded<T> access(AccessType access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of Embedded

access

Embedded<T> access(String access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of Embedded

getAccess

AccessType getAccess()

Returns the access attribute

Returns:

the value defined for the attribute access

getAccessAsString

String getAccessAsString()

Returns the access attribute

Returns:

the value found for the element access

removeAccess

Embedded<T> removeAccess()

Removes the access attribute

Returns:

the current instance of Embedded