/*

* Copyright (c) 2007-2008 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

package com.nokia.helium.sbs.ant.types;

import java.util.List;

import org.apache.tools.ant.types.Reference;

/**

 * This class provides user the option to store the one to one

 * mapping with raptor configuration. This is mainly there for backward

 * compatibility with schema 1.4.0 and would be deprecated in the future

 * when migrated to schema 3.0.0

 * 

 * <pre>

 * sbsbuild takes only sbsinput reference id. Each reference id contains 

 * list of raptor commands matching corresponding abld commands for a 

 * particular configuration in the system definition file schema 1.4.0.

 * 

 * Example 1:

 * 

 * <sbsbuild id="sbs.dfs_build_ncp">

 *      <sbsinput refid="dfs_build_ncp_input"/>

 * </sbsbuild>

 * </pre>

 * @ant.type name="arg" category="SBS"

 * @ant.type name="makeOption" category="SBS"

 */

public class SBSBuild extends DataType

{

    private String name;

    private Vector<SBSInput> sbsInputList = new Vector<SBSInput>();

    /**

     * Set the name of the variable.

     * @param name

     */

    public void setName(String nm) {

        name = nm;

    }

    /**

     * Gets the name of the build input.

     * @param name

     */

    public String getName() {

        return name;

    }

    /**

     * Creates an empty variable element and adds 

     * it to the variables list

     * @return empty Variable pair

     */

    public SBSInput createSBSInput() {

        SBSInput input =  new SBSInput();

        sbsInputList.add(input);

        return input;

    }

    /**

     * Gets the list of sbs input list for this build configuration. 

     * it to the variables list

     * @return empty Variable pair

     */

    public List<SBSInput> getSBSInputList() {

        List<SBSInput> inputList = new ArrayList<SBSInput>();

        Reference refId = getRefid();

        Object sbsInputObject = null;

        if (refId != null) {

            try {

                sbsInputObject = refId.getReferencedObject();

            } catch ( BuildException ex) {

                throw new BuildException("Reference id (" + refId.getRefId() + ") of sbsinput list is not valid");

            }

            if (sbsInputObject != null && sbsInputObject instanceof SBSInput) {

                inputList.add((SBSInput)sbsInputObject);

            }

        }

        inputList.addAll(sbsInputList);

        return inputList;

    }

}