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

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

Clean-room definition of JPA APIs intended for use in developing Hibernate JPA implementation. See README.md for details

The 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;

/**
 * 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
 * @since Java Persistence 2.0
 */
public interface SingularAttribute extends Attribute, Bindable {
	/**
	 * Is the attribute an id attribute.  This method will return
	 * true if the attribute is an attribute that corresponds to
	 * a simple id, an embedded id, or an attribute of an id class.
	 *
	 * @return boolean indicating whether the attribute is an id
	 */
	boolean isId();

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

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

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