javax.persistence.metamodel.SingularAttribute 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:$
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence.metamodel;

/**
 * Instances of the type SingularAttribute represents persistent
 * single-valued properties or fields.
 *
 * @param  The type containing the represented attribute
 * @param  The type of the represented attribute
 */
public interface SingularAttribute
		extends Attribute, Bindable {

	/**
	 * Is the attribute an id attribute.
	 *
	 * @return boolean indicating whether or not attribute is an id
	 */
	boolean isId();

	/**
	 * Is the attribute a version attribute.
	 *
	 * @return boolean indicating whether or not attribute is
	 *         a version attribute
	 */
	boolean isVersion();

	/**
	 * Can the attribute be null.
	 *
	 * @return boolean indicating whether or not the attribute can
	 *         be null
	 */
	boolean isOptional();

	/**
	 * Return the type that represents the type of the attribute.
	 *
	 * @return type of attribute
	 */
	Type getType();
}