org.hibernate.metamodel.model.domain.DomainType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-core Show documentation
Show all versions of hibernate-core Show documentation
Hibernate's core ORM functionality
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* License: GNU Lesser General Public License (LGPL), version 2.1 or later
* See the lgpl.txt file in the root directory or http://www.gnu.org/licenses/lgpl-2.1.html
*/
package org.hibernate.metamodel.model.domain;
/**
* Base contract for Hibernate's extension of the JPA type system.
*
* @apiNote The "real" JPA type system is more akin to
* {@link SimpleDomainType}. We begin our JPA type system extension
* a "level above" that. This is to allow for:
* 1) JPA does not define a Type for collections. It's
* understandable why, but leads to limitations in
* regards to being able to understand the type of an
* attribute - in JPA, when the attribute is plural the
* only descriptor info available is for the the collection
* is its Java type (Class).
* 2) specialized types like ANY
*
*
* @param The Java type for this JPA Type
*
* @apiNote The `*DomainType` naming pattern is used to more easily (visually)
* differentiate these extensions from the JPA ones in application use.
*
* @author Steve Ebersole
*/
public interface DomainType extends javax.persistence.metamodel.Type {
/**
* The name of the type - this is Hibernate notion of the type name including
* non-pojo mappings, etc.
*/
String getTypeName();
}