package org.mongodb.morphia;

import com.mongodb.DBObject;
import org.mongodb.morphia.mapping.MappedField;
import org.mongodb.morphia.mapping.Mapper;

import java.util.List;
import java.util.Map;
import java.util.Set;

The ObjectFactory is used by morphia to create instances of classes which can be customized to fit a particular applications needs.
/**
 * The ObjectFactory is used by morphia to create instances of classes which can be customized to fit a particular applications needs.
 */
public interface ObjectFactory {
    
Creates an instance of the given class.
Params:
clazz – type class to instantiate
Type parameters:
<T> –   the type of the entity
Returns:
the new instance/**
     * Creates an instance of the given class.
     *
     * @param clazz type class to instantiate
     * @param <T>   the type of the entity
     * @return the new instance
     */
    <T> T createInstance(Class<T> clazz);

    
Creates an instance of the class defined in the Mapper.CLASS_NAME_FIELDNAME field in the dbObject passed in. If that field is missing, the given Class is used instead. 
Params:
clazz – type class to instantiate
dbObj – the state to populate the new instance with
Type parameters:
<T> –   the type of the entity
Returns:
the new instance/**
     * Creates an instance of the class defined in the {@link Mapper#CLASS_NAME_FIELDNAME} field in the dbObject passed in.  If that field
     * is missing, the given Class is used instead.
     *
     * @param clazz type class to instantiate
     * @param dbObj the state to populate the new instance with
     * @param <T>   the type of the entity
     * @return the new instance
     */
    <T> T createInstance(Class<T> clazz, DBObject dbObj);

    
Creates an instance of the class defined in the Mapper.CLASS_NAME_FIELDNAME field in the dbObject passed in. If that field is missing, morphia attempts to the MappedField to determine which concrete class to instantiate. 
Params:
mapper – the Mapper to use
mf –     the MappedField to consult when creating the instance
dbObj –  the state to populate the new instance with
Returns:
the new instance/**
     * Creates an instance of the class defined in the {@link Mapper#CLASS_NAME_FIELDNAME} field in the dbObject passed in.  If that field
     * is missing, morphia attempts to the MappedField to determine which concrete class to instantiate.
     *
     * @param mapper the Mapper to use
     * @param mf     the MappedField to consult when creating the instance
     * @param dbObj  the state to populate the new instance with
     * @return the new instance
     */
    Object createInstance(Mapper mapper, MappedField mf, DBObject dbObj);

    
Defines how morphia creates a List object.
Params:
mf – the MappedField containing any metadata that might define the type of the List to create
Returns:
the List/**
     * Defines how morphia creates a List object.
     *
     * @param mf the MappedField containing any metadata that might define the type of the List to create
     * @return the List
     */
    List createList(MappedField mf);

    
Defines how morphia creates a Map object.
Params:
mf – the MappedField containing any metadata that might define the type of the Map to create
Returns:
the Map/**
     * Defines how morphia creates a Map object.
     *
     * @param mf the MappedField containing any metadata that might define the type of the Map to create
     * @return the Map
     */
    Map createMap(MappedField mf);

    
Defines how morphia creates a Set object.
Params:
mf – the MappedField containing any metadata that might define the type of the Set to create
Returns:
the Set/**
     * Defines how morphia creates a Set object.
     *
     * @param mf the MappedField containing any metadata that might define the type of the Set to create
     * @return the Set
     */
    Set createSet(MappedField mf);
}