1 /**

     2  * Copyright (c) 2010 Symbian Foundation and/or its subsidiary(-ies).

     3  * All rights reserved.

     4  * This component and the accompanying materials are made available

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

     6  * which accompanies this distribution, and is available

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

     8  *

     9  * Initial Contributors:

    10  * Symbian Foundation - initial contribution.

    11  * Contributors:

    12  * Description:

    13  * Overview:

    14  * Details:

    15  * Platforms/Drives/Compatibility:

    16  * Assumptions/Requirement/Pre-requisites:

    17  * Failures and causes:

    18  */

    19 package org.symbian.tools.tmw.core.projects;

    20 

    21 import java.io.InputStream;

    22 

    23 import org.eclipse.core.resources.IFile;

    24 import org.eclipse.core.resources.IProject;

    25 import org.eclipse.core.runtime.CoreException;

    26 import org.eclipse.core.runtime.IPath;

    27 import org.eclipse.core.runtime.IProgressMonitor;

    28 

    29 /**

    30  * This object can be set as facet install config for the core TMW facet

    31  * 

    32  * @author Eugene Ostroukhov (eugeneo@symbian.org)

    33  */

    34 public interface IProjectSetupConfig {

    35     /**

    36      * Performs project setup. Project will already be configured with 

    37      * validation support and JSDT support.

    38      */

    39     void initialize(IProject project, IProgressMonitor monitor);

    40 

    41     /**

    42      * Allows the framework to reduce dependence on exact project layout. I.e. 

    43      * some IDEs may want to introduce separation of the web resources and 

    44      * JavaScript source files.

    45      * 

    46      * @param project project to add file to

    47      * @param name file path relative to application root

    48      * @param contents stream with file contents

    49      * @param monitor progress monitor

    50      * @throws CoreException

    51      */

    52     IFile addFile(IProject project, IPath name, InputStream contents, IProgressMonitor monitor) throws CoreException;

    53 

    54     /**

    55      * Adds specified file to the list of the JS files that will be included in 

    56      * the application page

    57      * @param file workspace file. Framework is responsible to create proper 

    58      * application root-relative path

    59      */

    60     void addIncludedJsFile(IFile file);

    61 }