/*
 * 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.analysis.spi;

import org.netbeans.api.annotations.common.CheckForNull;
import org.netbeans.modules.refactoring.api.Scope;

/**When placed in a project's lookup, the analysis of the project will be performed
 * over the returned {@link Scope}.
 *
 * @author lahvac
 */
public interface AnalysisScopeProvider {
    
    /**Returns a {@link Scope} over which the analysis should run. Note the difference between
     * returning an empty {@link Scope}, in which case the analysis won't run over
     * any source, and a null, in which case the engine will try to infer the {@link Scope}
     * using other means.
     * 
     * @return the {@link Scope} over which the analysis should run, or null if it
     *         should be inferred by other means.
     */
    public @CheckForNull Scope getScope();
}
