org.hibernate.tuple.Instantiator.java Source code

Introduction

Here is the source code for org.hibernate.tuple.Instantiator.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.tuple;

import java.io.Serializable;

/**
 * Contract for implementors responsible for instantiating entity/component instances.
 *
 * @author Steve Ebersole
 */
public interface Instantiator extends Serializable {

    /**
     * Perform the requested entity instantiation.
     * <p/>
     * This form is never called for component instantiation, only entity instantiation.
     *
     * @param id The id of the entity to be instantiated.
     * @return An appropriately instantiated entity.
     */
    public Object instantiate(Serializable id);

    /**
     * Perform the requested instantiation.
     *
     * @return The instantiated data structure. 
     */
    public Object instantiate();

    /**
     * Performs check to see if the given object is an instance of the entity
     * or component which this Instantiator instantiates.
     *
     * @param object The object to be checked.
     * @return True is the object does represent an instance of the underlying
     * entity/component.
     */
    public boolean isInstance(Object object);
}