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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jpa-api Show documentation

Hibernate developmental JSR 317 (Java Persistence API 2.0) contracts. Used to allow incremental implementation of features on the way to full JPA 2.0 support.

The newest version!

// $Id: Bindable.java 17038 2009-07-08 10:58:24Z epbernard $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.metamodel;

/**
 * Instances of the type Bindable represent object or attribute types
 * that can be bound into a Path.
 *
 * @param   The type of the represented object or attribute
 */
public interface Bindable {

	public static enum BindableType {
		SINGULAR_ATTRIBUTE, PLURAL_ATTRIBUTE, ENTITY_TYPE
	}

	/**
	 * Return the bindable type of the represented object.
	 *
	 * @return bindable type
	 */
	BindableType getBindableType();

	/**
	 * Return the Java type of the represented object.
	 * If the bindable type of the object is PLURAL_ATTRIBUTE,
	 * the Java element type is returned. If the bindable type is
	 * SINGULAR_ATTRIBUTE or ENTITY_TYPE, the Java type of the
	 * represented entity or attribute is returned.
	 *
	 * @return Java type
	 */
	Class getBindableJavaType();
}