jakarta.persistence.metamodel.MapAttribute Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jakarta.persistence-api Show documentation

There is a newer version: 3.2.0

Show newest version

/*
 * Copyright (c) 2008, 2023 Oracle and/or its affiliates. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v. 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0,
 * or the Eclipse Distribution License v. 1.0 which is available at
 * http://www.eclipse.org/org/documents/edl-v10.php.
 *
 * SPDX-License-Identifier: EPL-2.0 OR BSD-3-Clause
 */

// Contributors:
//     Linda DeMichiel - 2.1
//     Linda DeMichiel - 2.0

package jakarta.persistence.metamodel;

/**
 * Instances of the type {@code MapAttribute} represent
 * persistent {@link 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 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();
}