/*
 *                 Sun Public License Notice
 *
 * The contents of this file are subject to the Sun Public License
 * Version 1.0 (the "License"). You may not use this file except in
 * compliance with the License. A copy of the License is available at
 * http://www.sun.com/
 *
 * The Original Code is NetBeans. The Initial Developer of the Original
 * Code is Sun Microsystems, Inc. Portions Copyright 1997-2004 Sun
 * Microsystems, Inc. All Rights Reserved.
 */

package org.netbeans.modules.javacore.jmiimpl.javamodel;

import org.netbeans.jmi.javamodel.Expression;
import org.netbeans.jmi.javamodel.ForEachStatement;
import org.netbeans.jmi.javamodel.ForEachStatementClass;
import org.netbeans.jmi.javamodel.Parameter;
import org.netbeans.jmi.javamodel.Statement;
import org.netbeans.mdr.storagemodel.StorableClass;

/**
 * Factory class for creating ForEachStatement instances, i.e.
 * 
 * Collection c = ...;
 * for (String s : c) {
 *    ...
 * }
 * 
 *
 * @author  Pavel Flaska
 */
public abstract class ForEachStatementClassImpl extends MEFactory implements ForEachStatementClass {
    
    /**
     * Creates a new instance of ForEachStatementClassImpl 
     *
     * @param c  creates handler for this storable
     */
    public ForEachStatementClassImpl(StorableClass c) {
        super(c);
    }
    
    /**
     * The default factory operation used to create an instance object.
     *
     * @return The created instance object.
     */
    public ForEachStatement createForEachStatement() {
        return create(null, null, null);
    }
    
    /**
     * Creates an instance object having attributes initialized by the passed 
     * values.
     * @param body       represents the body of the for loop element
     * @param parameter  
     * @param iterable 
     * @return The created instance object.
     */
    public ForEachStatement createForEachStatement(Statement body, Parameter parameter, Expression iterable)  {
        return create(body, parameter, iterable);
    }
    
    // .........................................................................
    // PRIVATE MEMBERS
    // .........................................................................
    private ForEachStatementImpl create(Statement body, Parameter parameter, Expression iterable) {
        ForEachStatementImpl result = (ForEachStatementImpl) create(null);
        result.setNew();
        result.setData(body, parameter, iterable);
        return result;
    }
}