<change id="Scope">

        <api name="refactoring"/>

        <summary>Scope added to allow to specify a limited scope for WhereUsedQuery</summary>

        <version major="1" minor="18"/>

        <date day="30" month="6" year="2011"/>

        <author login="ralphbenjamin"/>

        <compatibility addition="yes"/>

        <description>

            <p>

                Scope is used to limit the WhereUsedQuery to a specific scope.<br />

                An instance is added to the context of WhereUsedQuery to limit the

                scope. A custom scope can be any combination of source roots, folders

                and files.

            </p>    

        </description>

        <class package="org.netbeans.modules.refactoring.api" name="Scope"/>

        <issue number="199779"/>

    </change>

/*

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 *

 * Copyright 2011 Oracle and/or its affiliates. All rights reserved.

 *

 * Oracle and Java are registered trademarks of Oracle and/or its affiliates.

 * Other names may be trademarks of their respective owners.

 *

 * The contents of this file are subject to the terms of either the GNU

 * General Public License Version 2 only ("GPL") or the Common

 * Development and Distribution License("CDDL") (collectively, the

 * "License"). You may not use this file except in compliance with the

 * License. You can obtain a copy of the License at

 * http://www.netbeans.org/cddl-gplv2.html

 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the

 * specific language governing permissions and limitations under the

 * License.  When distributing the software, include this License Header

 * Notice in each file and include the License file at

 * nbbuild/licenses/CDDL-GPL-2-CP.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the GPL Version 2 section of the License file that

 * accompanied this code. If applicable, add the following below the

 * License Header, with the fields enclosed by brackets [] replaced by

 * your own identifying information:

 * "Portions Copyrighted [year] [name of copyright owner]"

 *

 * If you wish your version of this file to be governed by only the CDDL

 * or only the GPL Version 2, indicate your decision by adding

 * "[Contributor] elects to include this software in this distribution

 * under the [CDDL or GPL Version 2] license." If you do not indicate a

 * single choice of license, a recipient has the option to distribute

 * your version of this file under either the CDDL, the GPL Version 2 or

 * to extend the choice of license to its licensees as provided above.

 * However, if you add GPL Version 2 code and therefore, elected the GPL

 * Version 2 license, then the option applies only if the new code is

 * made subject to such option by the copyright holder.

 *

 * Contributor(s):

 *

 * Portions Copyrighted 2011 Sun Microsystems, Inc.

 */

package org.netbeans.modules.refactoring.api;

import java.util.Collections;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Map;

import java.util.Set;

import javax.tools.FileObject;

import org.netbeans.api.annotations.common.NonNull;

import org.netbeans.api.fileinfo.NonRecursiveFolder;

import org.openide.util.Parameters;

/**

 * Scope is used to limit the WhereUsedQuery to a specific scope.

 * Add an instance of this class to the context of the WhereUsedQuery to limit

 * the scope. A custom scope can be any combination of source roots, folders and

 * files.

 * 

 * @author Ralph Ruijs

 * @see Context

 * @since 1.18

 */

public final class Scope {

    private final Set<FileObject> sourceRoots;

    private final Map<FileObject, Set<NonRecursiveFolder>> folders;

    private final Set<FileObject> files;

    /**

     * Creates a new empty scope.

     */

    public Scope() {

        folders = new HashMap<FileObject, Set<NonRecursiveFolder>>();

        sourceRoots = new HashSet<FileObject>();

        files = new HashSet<FileObject>();

    }

    /**

     * Add files to this Set to include them in the where used query.

     * 

     * @return the files to include in the where used query

     */

    public @NonNull Set<FileObject> getFiles() {

        return files;

    }

    /**

     * Add NonRecursiveFolders to this Set to include them in the where used query.

     * 

     * @param sourceRoot - the source root, the folders belong to

     * @return the folders to include in the where used query

     */

    public @NonNull Set<NonRecursiveFolder> getFolders(@NonNull FileObject sourceRoot) {

        Parameters.notNull("sourceRoot", sourceRoot);

        Set<NonRecursiveFolder> folderSet = folders.get(sourceRoot);

        if (folderSet == null) {

            folderSet = new HashSet<NonRecursiveFolder>();

            folders.put(sourceRoot, folderSet);

        }

        return folderSet;

    }

    /**

     * Use the source roots returned by this method to find all the available

     * folders in this custom scope.

     * 

     * @see Scope#getFolders(org.openide.filesystems.FileObject) 

     * @return an unmodifiable Set of the source roots used for folders

     */

    public @NonNull Set<FileObject> getFoldersSourceRoots() {

        return Collections.unmodifiableSet(folders.keySet());

    }

    /**

     * Add SourceRoots to this Set to include them as a whole in the where used query.

     * 

     * @return the source roots to include in the where used query

     */

    public @NonNull Set<FileObject> getSourceRoots() {

        return sourceRoots;

    }

}