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

Go to download
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 {
	/**
	 * Return the type that represents the type of the attribute.
	 * 
	 * @return type of attribute
	 */
	Type getType();

	/**
	 * 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();

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

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