/*
 * This code is distributed under The GNU Lesser General Public License (LGPLv3)
 * Please visit GNU site for LGPLv3 http://www.gnu.org/copyleft/lesser.html
 *
 * Copyright Denis Pavlov 2009
 * Web: http://www.genericdtoassembler.org
 * SVN: https://svn.code.sf.net/p/geda-genericdto/code/trunk/
 * SVN (mirror): http://geda-genericdto.googlecode.com/svn/trunk/
 */

package com.inspiresoftware.lib.dto.geda.dsl;

import com.inspiresoftware.lib.dto.geda.assembler.extension.DisposableContainer;

/**
 * Registry allows user to use DSL style mapping for DTO objects.
 * When methods are invoked all information is stored within
 * registry and kept for when it is used with assembler.
 *
 * @since 3.0.0
 *
 * User: denispavlov
 * Date: 13-02-20
 * Time: 9:15 AM
 */
public interface Registry extends DisposableContainer {
    /**
     * Check if this registry has this DTO.
     *
     * @param dtoClass dto class
     * @return dto mapping context or null
     */
    DtoContext has(Class dtoClass);

    /**
     * New DTO mapping by given dto class.
     *
     * @param dtoClass dto class
     * @return dto mapping context
     */
    DtoContext dto(Class dtoClass);

    /**
     * New DTO mapping by given dto instance.
     *
     * @param dtoInstance instance of dto class
     * @return dto mapping context
     */
    DtoContext dto(Object dtoInstance);

    /**
     * New DTO mapping by given dto bean key (used by {@link com.inspiresoftware.lib.dto.geda.adapter.BeanFactory}).
     *
     * @param beanKey bean key of dto class
     * @return dto mapping context
     */
    DtoContext dto(String beanKey);

}