package com.sourceforge.jpatterns.core.configuration.model;

 import com.sourceforge.jpatterns.schema.JPatternsConfig;

 import java.util.List;

 /**

  * This interface defines the builder facilities for constructing the <code>JPatternsConfigBaseBean</code> from the provided

  * <code>JPatternsConfig</code> object.

  *

  * $Author:: zmicer             $<br/>

  * $Rev:: 57                    $<br/> * $Date:: 2007-08-23 09:16:37 #$<br/>

  * $Date:: 2007-08-23 09:16:37 #$<br/>

  */

 public interface IJPatternsConfigBeansBuilder

 {

     /**

      * Build the <code>JPatternsConfigBaseBean</code> using the provided <code>JPatternsConfig</code> object.

      * <br/>            

      * Please review the JavaDocs to get the info about the algorithm the concrete implementation uses.

      *

      * @param config JPatternsConfig castor object. Not normalized castor config object should be passed here\

      *               ({@link com.sourceforge.jpatterns.utils.CastorUtils#validateAndNormalizeScopesPriorities(com.sourceforge.jpatterns.schema.JPatternsConfig)}).

      *               Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *

      * @return JPatternsConfigBean castor object built using the provided <code>JPatternsConfig</code> castor root object.

      */

     JPatternsConfigBean build(final JPatternsConfig config);

     /**

      * Build as {@link JPatternsConfigsBean} using the List of {@link JPatternsConfigBean} objects

      * <br/>

      * Please be noticed this method could be used for the prioritized building. In this case one of the beans is passed here should have

      * been already prioritized (it should have been created using the

      * {@link com.sourceforge.jpatterns.utils.CastorUtils#makePrioritized(com.sourceforge.jpatterns.schema.JPatternsConfig)} method)

      *

      * @param beans the List of JPatternsConfigBean objects, Can not be null (otherwise <code>IllegalArgumentException</code> would appear).

      *              Should be built using normalized configs.

      *

      * @return the built <code>JPatternsConfigsBean</code>, in the case of empty <code>beans</code> just initial version of this bean

      *         would returned.

      */

     JPatternsConfigsBean build(final List<JPatternsConfigBaseBean> beans);

 }