Java Persistence API 2.2 · javax.persistence.metamodel.IdentifiableType

Method Summary

Modifier and Type	Method and Description
public <Y> SingularAttribute<X, Y>	Returns: declared id attribute getDeclaredId(Class<Y> the type of the represented declared id attribute type) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.
public <Y> SingularAttribute<X, Y>	Returns: declared version attribute getDeclaredVersion(Class<Y> the type of the represented declared version attribute type) Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.
public <Y> SingularAttribute<? super X, Y>	Returns: id attribute getId(Class<Y> the type of the represented id attribute type) Return the attribute that corresponds to the id attribute of the entity or mapped superclass.
public Set<SingularAttribute<? super X, ?>>	Returns: id attributes getIdClassAttributes() Return the attributes corresponding to the id class of the identifiable type.
public Type<?>	Returns: type of id getIdType() Return the type that represents the type of the id.
public IdentifiableType<? super X>	Returns: supertype of identifiable type or null if no such supertype getSupertype() Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.
public <Y> SingularAttribute<? super X, Y>	Returns: version attribute getVersion(Class<Y> the type of the represented version attribute type) Return the attribute that corresponds to the version attribute of the entity or mapped superclass.
public boolean	Returns: boolean indicating whether the identifiable type has a single id attribute hasSingleIdAttribute() Whether the identifiable type has a single id attribute.
public boolean	Returns: boolean indicating whether the identifiable type has a version attribute hasVersionAttribute() Whether the identifiable type has a version attribute.

Method Detail

getDeclaredId	back to summary
public <Y> SingularAttribute<X, Y> getDeclaredId(Class<Y> type) Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass. Parameters type:Class<Y> the type of the represented declared id attribute Returns:SingularAttribute<X, Y> declared id attribute Exceptions IllegalArgumentException: if id attribute of the given type is not declared in the identifiable type or if the identifiable type has an id class

getDeclaredId

back to summary

public <Y> SingularAttribute<X, Y> getDeclaredId(Class<Y> type)

Return the attribute that corresponds to the id attribute declared by the entity or mapped superclass.

Parameters

type:Class<Y>: the type of the represented declared id attribute

Returns:SingularAttribute<X, Y>

declared id attribute

Exceptions

IllegalArgumentException:: if id attribute of the given type is not declared in the identifiable type or if the identifiable type has an id class

getDeclaredVersion	back to summary
public <Y> SingularAttribute<X, Y> getDeclaredVersion(Class<Y> type) Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass. Parameters type:Class<Y> the type of the represented declared version attribute Returns:SingularAttribute<X, Y> declared version attribute Exceptions IllegalArgumentException: if version attribute of the type is not declared in the identifiable type

getDeclaredVersion

back to summary

public <Y> SingularAttribute<X, Y> getDeclaredVersion(Class<Y> type)

Return the attribute that corresponds to the version attribute declared by the entity or mapped superclass.

Parameters

type:Class<Y>: the type of the represented declared version attribute

Returns:SingularAttribute<X, Y>

declared version attribute

Exceptions

IllegalArgumentException:: if version attribute of the type is not declared in the identifiable type

getId	back to summary
public <Y> SingularAttribute<? super X, Y> getId(Class<Y> type) Return the attribute that corresponds to the id attribute of the entity or mapped superclass. Parameters type:Class<Y> the type of the represented id attribute Returns:SingularAttribute<? super X, Y> id attribute Exceptions IllegalArgumentException: if id attribute of the given type is not present in the identifiable type or if the identifiable type has an id class

getId

back to summary

public <Y> SingularAttribute<? super X, Y> getId(Class<Y> type)

Return the attribute that corresponds to the id attribute of the entity or mapped superclass.

Parameters

type:Class<Y>: the type of the represented id attribute

Returns:SingularAttribute<? super X, Y>

id attribute

Exceptions

IllegalArgumentException:: if id attribute of the given type is not present in the identifiable type or if the identifiable type has an id class

getIdClassAttributes	back to summary
public Set<SingularAttribute<? super X, ?>> getIdClassAttributes() Return the attributes corresponding to the id class of the identifiable type. Returns:Set<SingularAttribute<? super X, ?>> id attributes Exceptions IllegalArgumentException: if the identifiable type does not have an id class

getIdClassAttributes

back to summary

public Set<SingularAttribute<? super X, ?>> getIdClassAttributes()

Return the attributes corresponding to the id class of the identifiable type.

Returns:Set<SingularAttribute<? super X, ?>>

id attributes

Exceptions

IllegalArgumentException:: if the identifiable type does not have an id class

getIdType	back to summary
public Type<?> getIdType() Return the type that represents the type of the id. Returns:Type<?> type of id

getIdType

back to summary

public Type<?> getIdType()

Return the type that represents the type of the id.

Returns:Type<?>: type of id

getSupertype	back to summary
public IdentifiableType<? super X> getSupertype() Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass. Returns:IdentifiableType<? super X> supertype of identifiable type or null if no such supertype

getSupertype

back to summary

public IdentifiableType<? super X> getSupertype()

Return the identifiable type that corresponds to the most specific mapped superclass or entity extended by the entity or mapped superclass.

Returns:IdentifiableType<? super X>: supertype of identifiable type or null if no such supertype

getVersion	back to summary
public <Y> SingularAttribute<? super X, Y> getVersion(Class<Y> type) Return the attribute that corresponds to the version attribute of the entity or mapped superclass. Parameters type:Class<Y> the type of the represented version attribute Returns:SingularAttribute<? super X, Y> version attribute Exceptions IllegalArgumentException: if version attribute of the given type is not present in the identifiable type

getVersion

back to summary

public <Y> SingularAttribute<? super X, Y> getVersion(Class<Y> type)

Return the attribute that corresponds to the version attribute of the entity or mapped superclass.

Parameters

type:Class<Y>: the type of the represented version attribute

Returns:SingularAttribute<? super X, Y>

version attribute

Exceptions

IllegalArgumentException:: if version attribute of the given type is not present in the identifiable type

hasSingleIdAttribute	back to summary
public boolean hasSingleIdAttribute() Whether the identifiable type has a single id attribute. Returns true for a simple id or embedded id; returns false for an idclass. Returns:boolean boolean indicating whether the identifiable type has a single id attribute

hasSingleIdAttribute

back to summary

public boolean hasSingleIdAttribute()

Whether the identifiable type has a single id attribute. Returns true for a simple id or embedded id; returns false for an idclass.

Returns:boolean: boolean indicating whether the identifiable type has a single id attribute

hasVersionAttribute	back to summary
public boolean hasVersionAttribute() Whether the identifiable type has a version attribute. Returns:boolean boolean indicating whether the identifiable type has a version attribute

hasVersionAttribute

back to summary

public boolean hasVersionAttribute()

Whether the identifiable type has a version attribute.

Returns:boolean: boolean indicating whether the identifiable type has a version attribute

public Interface IdentifiableType<X>

Method Summary

Method Detail