javax.persistence.metamodel.Metamodel Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javax.persistence Show documentation

The Java Persistence API (JPA) : a standard interface-based Java model abstraction of persistence, developed by the JCP.

There is a newer version: 2.2.4

Show newest version

/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
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
     * @param  Type
     */
     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
     * @param  Type
     */
     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
     * @param  Type
     */
     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();
}