org.hibernate.metadata.CollectionMetadata.java Source code

Introduction

Here is the source code for org.hibernate.metadata.CollectionMetadata.java

Source

/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or <http://www.gnu.org/licenses/lgpl-2.1.html>.
 */
package org.hibernate.metadata;

import org.hibernate.type.Type;

/**
 * Exposes collection metadata to the application
 *
 * @author Gavin King
 */
public interface CollectionMetadata {
    /**
     * The collection key type
     */
    public Type getKeyType();

    /**
     * The collection element type
     */
    public Type getElementType();

    /**
     * The collection index type (or null if the collection has no index)
     */
    public Type getIndexType();

    /**
     * Is this collection indexed?
     */
    public boolean hasIndex();

    /**
     * The name of this collection role
     */
    public String getRole();

    /**
     * Is the collection an array?
     */
    public boolean isArray();

    /**
     * Is the collection a primitive array?
     */
    public boolean isPrimitiveArray();

    /**
     * Is the collection lazily initialized?
     */
    public boolean isLazy();
}