javax.persistence.metamodel.Attribute 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: Attribute.java 17038 2009-07-08 10:58:24Z epbernard $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.metamodel;

/**
 * An attribute of a Java type
 *
 * @param  The represented type that contains the attribute
 * @param  The type of the represented attribute
 */
public interface Attribute {

	public static enum PersistentAttributeType {
		MANY_TO_ONE, ONE_TO_ONE, BASIC, EMBEDDED,
		MANY_TO_MANY, ONE_TO_MANY, ELEMENT_COLLECTION
	}

	/**
	 * Return the name of the attribute.
	 *
	 * @return name
	 */
	String getName();

	/**
	 * Return the persistent attribute type for the attribute.
	 *
	 * @return persistent attribute type
	 */
	PersistentAttributeType getPersistentAttributeType();

	/**
	 * Return the managed type representing the type in which
	 * the attribute was declared.
	 *
	 * @return declaring type
	 */
	ManagedType getDeclaringType();

	/**
	 * Return the Java type of the represented attribute.
	 *
	 * @return Java type
	 */
	Class getJavaType();

	/**
	 * Return the java.lang.reflect.Member for the represented
	 * attribute.
	 *
	 * @return corresponding java.lang.reflect.Member
	 */
	java.lang.reflect.Member getJavaMember();

	/**
	 * Is the attribute an association.
	 *
	 * @return whether boolean indicating whether attribute
	 *         corresponds to an association
	 */
	boolean isAssociation();

	/**
	 * Is the attribute collection-valued.
	 *
	 * @return boolean indicating whether attribute is
	 *         collection-valued
	 */
	boolean isCollection();
}