Instantiator.java

/**
 * Copyright (C) 2009 STMicroelectronics
 *
 * This file is part of "Mind Compiler" is free software: you can redistribute 
 * it and/or modify it under the terms of the GNU Lesser General Public License 
 * as published by the Free Software Foundation, either version 3 of the 
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT 
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Contact: mind@ow2.org
 *
 * Authors: Matthieu Leclercq
 * Contributors: 
 */

package org.ow2.mind.adl.graph;

import java.util.Map;

import org.objectweb.fractal.adl.ADLException;
import org.objectweb.fractal.adl.Definition;
import org.ow2.mind.inject.InjectDelegate;

/**
 * Instantiator interface allows to instantiate an ADL definition into a graph
 * of component.
 */
public interface Instantiator {

  /**
   * Instantiate the given definition into a {@link ComponentGraph}.
   * 
   * @param definition the definition to instantiate.
   * @param context additional parameters.
   * @return a {@link ComponentGraph}.
   * @throws ADLException if the instantiation fails.
   */
  ComponentGraph instantiate(Definition definition, Map<Object, Object> context)
      throws ADLException;

  /**
   * An abstract delegating {@link Instantiator} component.
   */
  public abstract class AbstractDelegatingInstantiator implements Instantiator {

    /**
     * The client {@link Instantiator} used by this component.
     */
    @InjectDelegate
    protected Instantiator clientInstantiatorItf;
  }
}