org.jboss.shrinkwrap.descriptor.api.orm10

Interface Embeddable<T>

All Superinterfaces:

Child<T>, OrmEmbeddableCommType<T,Embeddable<T>,EmbeddableAttributes<Embeddable<T>>>

public interface Embeddable<T>
extends Child<T>, OrmEmbeddableCommType<T,Embeddable<T>,EmbeddableAttributes<Embeddable<T>>>

This interface defines the contract for the embeddable xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger, George Gastaldi

Method Summary

Modifier and Type	Method and Description
Embeddable<T>	access(AccessType access) Sets the access attribute
Embeddable<T>	access(String access) Sets the access attribute
Embeddable<T>	clazz(String clazz) Sets the class attribute
Embeddable<T>	description(String description) Sets the description element
AccessType	getAccess() Returns the access attribute
String	getAccessAsString() Returns the access attribute
String	getClazz() Returns the class attribute
String	getDescription() Returns the description element
EmbeddableAttributes<Embeddable<T>>	getOrCreateAttributes() If not already created, a new attributes element with the given value will be created.
Boolean	isMetadataComplete() Returns the metadata-complete attribute
Embeddable<T>	metadataComplete(Boolean metadataComplete) Sets the metadata-complete attribute
Embeddable<T>	removeAccess() Removes the access attribute
Embeddable<T>	removeAttributes() Removes the attributes element
Embeddable<T>	removeClazzAttr() Removes the class attribute
Embeddable<T>	removeDescription() Removes the description element
Embeddable<T>	removeMetadataComplete() Removes the metadata-complete attribute

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

up

Method Detail

description

Embeddable<T> description(String description)

Sets the description element

Parameters:

description - the value for the element description

Returns:

the current instance of Embeddable

getDescription

String getDescription()

Returns the description element

Returns:

the node defined for the element description

removeDescription

Embeddable<T> removeDescription()

Removes the description element

Returns:

the current instance of Embeddable

getOrCreateAttributes

EmbeddableAttributes<Embeddable<T>> getOrCreateAttributes()

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

Returns:

a new or existing instance of EmbeddableAttributes>

removeAttributes

Embeddable<T> removeAttributes()

Removes the attributes element

Returns:

the current instance of Embeddable

clazz

Embeddable<T> clazz(String clazz)

Sets the class attribute

Parameters:

clazz - the value for the attribute class

Returns:

the current instance of Embeddable

getClazz

String getClazz()

Returns the class attribute

Returns:

the value defined for the attribute class

removeClazzAttr

Embeddable<T> removeClazzAttr()

Removes the class attribute

Returns:

the current instance of Embeddable

access

Embeddable<T> access(AccessType access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of Embeddable

access

Embeddable<T> access(String access)

Sets the access attribute

Parameters:

access - the value for the attribute access

Returns:

the current instance of Embeddable

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

Embeddable<T> removeAccess()

Removes the access attribute

Returns:

the current instance of Embeddable

metadataComplete

Embeddable<T> metadataComplete(Boolean metadataComplete)

Sets the metadata-complete attribute

Parameters:

metadataComplete - the value for the attribute metadata-complete

Returns:

the current instance of Embeddable

isMetadataComplete

Boolean isMetadataComplete()

Returns the metadata-complete attribute

Returns:

the value defined for the attribute metadata-complete

removeMetadataComplete

Embeddable<T> removeMetadataComplete()

Removes the metadata-complete attribute

Returns:

the current instance of Embeddable