javax.persistence.metamodel.Metamodel Maven / Gradle / Ivy
// $Id: Metamodel.java 17752 2009-10-15 01:19:21Z [email protected] $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.metamodel;
import java.util.Set;
/**
* Provides access to the metamodel of persistent
* entities in the persistence unit.
*
* @since Java Persistence 2.0
*/
public interface Metamodel {
/**
* Return the metamodel entity type representing the entity.
*
* @param cls the type of the represented entity
*
* @return the metamodel entity type
*
* @throws IllegalArgumentException if not an entity
*/
EntityType entity(Class cls);
/**
* Return the metamodel managed type representing the
* entity, mapped superclass, or embeddable class.
*
* @param cls the type of the represented managed class
*
* @return the metamodel managed type
*
* @throws IllegalArgumentException if not a managed class
*/
ManagedType managedType(Class cls);
/**
* Return the metamodel embeddable type representing the
* embeddable class.
*
* @param cls the type of the represented embeddable class
*
* @return the metamodel embeddable type
*
* @throws IllegalArgumentException if not an embeddable class
*/
EmbeddableType embeddable(Class cls);
/**
* Return the metamodel managed types.
*
* @return the metamodel managed types
*/
Set> getManagedTypes();
/**
* Return the metamodel entity types.
*
* @return the metamodel entity types
*/
Set> getEntities();
/**
* Return the metamodel embeddable types. Returns empty set
* if there are no embeddable types.
*
* @return the metamodel embeddable types
*/
Set> getEmbeddables();
}