javax.persistence.metamodel

Interface IdentifiableType<X>

Contents
  • Type Parameters:
    X - The represented entity or mapped superclass type.
    All Superinterfaces:
    ManagedType<X>, Type<X>
    All Known Subinterfaces:
    EntityType<X>, MappedSuperclassType<X>

    public interface IdentifiableType<X>
extends ManagedType<X>
    Instances of the type IdentifiableType represent entity or mapped superclass types.
    Since:
    Java Persistence 2.0

    • Method Detail

      • getId

        <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 - the type of the represented id attribute
        Returns:
        id attribute
        Throws:
        IllegalArgumentException - if id attribute of the given type is not present in the identifiable type or if the identifiable type has an id class

      • getDeclaredId

        <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 - the type of the represented declared id attribute
        Returns:
        declared id attribute
        Throws:
        IllegalArgumentException - if id attribute of the given type is not declared in the identifiable type or if the identifiable type has an id class

      • getVersion

        <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 - the type of the represented version attribute
        Returns:
        version attribute
        Throws:
        IllegalArgumentException - if version attribute of the given type is not present in the identifiable type

      • getDeclaredVersion

        <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 - the type of the represented declared version attribute
        Returns:
        declared version attribute
        Throws:
        IllegalArgumentException - if version attribute of the type is not declared in the identifiable type

      • getSupertype

        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:
        supertype of identifiable type or null if no such supertype

      • hasSingleIdAttribute

        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 indicating whether the identifiable type has a single id attribute

      • hasVersionAttribute

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

      • getIdClassAttributes

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

      • getIdType

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

Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/persistence/metamodel/identifiabletype.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.