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

/*
 * 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 PluralAttribute represent
 * persistent collection-valued attributes.
 *
 * @param  The type the represented collection belongs to
 * @param  The type of the represented collection
 * @param  The element type of the represented collection
 * @since Java Persistence 2.0
 */
public interface PluralAttribute extends Attribute, Bindable {
	public static enum CollectionType {
		/**
		 * Collection-valued attribute
		 */
		COLLECTION,

		/**
		 * Set-valued attribute
		 */
		SET,

		/**
		 * List-valued attribute
		 */
		LIST,

		/**
		 * Map-valued attribute
		 */
		MAP
	}

	/**
	 * Return the collection type.
	 *
	 * @return collection type
	 */
	CollectionType getCollectionType();

	/**
	 * Return the type representing the element type of the
	 * collection.
	 *
	 * @return element type
	 */
	Type getElementType();
}