/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.netbeans.modules.web.clientproject.api;

import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.api.annotations.common.NonNull;
import org.openide.filesystems.FileObject;

/**
 * Class representing Client Side project.
 * <p>
 * Its implementation can be gotten from project's lookup.
 * @since 1.11
 */
public interface ClientSideModule {

    /**
     * Get properties of this module.
     * @return
     */
    @NonNull
    Properties getProperties();

    //~ Inner classes

    /**
     * Class representing project properties.
     */
    public interface Properties {

        /**
         * Get the start file of this module. It can be {@code null}
         * if the project is incorrectly configured.
         * @return start file of this module, can be {@code null}
         */
        @CheckForNull
        FileObject getStartFile();

        /**
         * Get context root of this module.
         * @return context root of this module
         */
        @NonNull
        String getWebContextRoot();
        
    }

}
