javax.persistence.metamodel.MapAttribute 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 MapAttribute represent
 * persistent java.util.Map-valued attributes.
 *
 * @param  The type the represented Map belongs to
 * @param  The type of the key of the represented Map
 * @param  The type of the value of the represented Map
 * @since Java Persistence 2.0
 */
public interface MapAttribute extends PluralAttribute, V> {
	/**
	 * Return the Java type of the map key.
	 *
	 * @return Java key type
	 */
	Class getKeyJavaType();

	/**
	 * Return the type representing the key type of the map.
	 *
	 * @return type representing key type
	 */
	Type getKeyType();
}