<specification-version>1.59</specification-version>

import java.net.URI;

import java.util.HashSet;

import java.util.regex.Pattern;

import org.apache.tools.ant.module.api.support.ActionUtils;

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

import org.netbeans.api.java.queries.SourceForBinaryQuery;

import org.openide.filesystems.URLMapper;

import org.openide.loaders.DataFolder;

        final Lookup lookup = original.getLookup();

        final org.netbeans.spi.project.ui.PathFinder pathFinder =

                lookup.lookup(org.netbeans.spi.project.ui.PathFinder.class);

    private static final class PathFinder implements org.netbeans.spi.project.ui.PathFinder {

        private static final Pattern SRCDIRJAVA = Pattern.compile("\\.java$"); // NOI18N

        private static final String SUBST = ".class"; // NOI18N

        //@GuardBy("PathFinder.class")

        private static URI currentKey;

        //@GuardBy("PathFinder.class")

        private static Set<URI> currentValues;

        private final org.netbeans.spi.project.ui.PathFinder delegate;

        public PathFinder(@NullAllowed final org.netbeans.spi.project.ui.PathFinder delegate) {

            this.delegate = delegate;

        }

        @Override

        public Node findPath(Node root, Object target) {

            Node result = null;

            if (delegate != null && target instanceof FileObject) {

                FileObject binRoot = root.getLookup().lookup(FileObject.class);

                if (binRoot == null) {

                    final DataFolder dobj = root.getLookup().lookup(DataFolder.class);

                    binRoot = dobj == null ? null : dobj.getPrimaryFile();

                }

                if (binRoot != null) {

                    FileObject newTarget = rebase(binRoot, (FileObject) target);

                    if (newTarget != null) {

                        result = delegate.findPath(root, newTarget);

                    }

                }

            }

            return result;

        }

        @CheckForNull

        static FileObject rebase(

                @NonNull final FileObject binRoot,

                @NonNull final FileObject sourceTarget) {

            if (shouldIgnore(sourceTarget.toURI(), binRoot.toURI())) {

                return null;

            }

            final URL providedBinRootURL = (URL) sourceTarget.getAttribute("classfile-root");    //NOI18N

            final String providedBinaryName = (String) sourceTarget.getAttribute("classfile-binaryName");   //NOI18N

            if (providedBinRootURL != null && providedBinaryName != null) {

                final FileObject providedBinRoot = URLMapper.findFileObject(providedBinRootURL);

                if (binRoot.equals(providedBinRoot)) {

                    return binRoot.getFileObject(providedBinaryName + SUBST);

                }

            } else {

                for (FileObject srcRoot : SourceForBinaryQuery.findSourceRoots(binRoot.toURL()).getRoots()) {

                    if (FileUtil.isParentOf(srcRoot, sourceTarget)) {

                        final FileObject[] newTarget = ActionUtils.regexpMapFiles(

                            new FileObject[]{sourceTarget},

                            srcRoot,

                            SRCDIRJAVA,

                            binRoot,

                            SUBST,

                            true);

                        if (newTarget != null) {

                            return newTarget[0];

                        }

                    }

                }

            }

            ignore(sourceTarget.toURI(), binRoot.toURI());

            return null;

        }

        private static synchronized boolean shouldIgnore (

                @NonNull final URI key,

                @NonNull final URI value) {

            if (!key.equals(currentKey)) {

                return false;

            }

            return currentValues.contains(value);

        }

        private static synchronized void ignore(

                @NonNull final URI key,

                @NonNull final URI value) {

            if (!key.equals(currentKey)) {

                currentKey = key;

                currentValues = new HashSet<URI>();

            }

            currentValues.add(value);

        }

    }

    private static final class PathFinder implements org.netbeans.spi.project.ui.PathFinder {

        PathFinder() {

        }

        @Override

        public Node findPath(Node root, Object target) {

            Node result = null;

            for (Node  node : root.getChildren().getNodes(true)) {

                final org.netbeans.spi.project.ui.PathFinder pf =

                    node.getLookup().lookup(org.netbeans.spi.project.ui.PathFinder.class);

                if (pf == null) {

                    continue;

                }

                result = pf.findPath(node, target);

                if (result != null) {

                    break;

                }

            }

            return result;

        }

    }

    private static final class PathFinder implements org.netbeans.spi.project.ui.PathFinder {

        PathFinder() {

        }

        @Override

        public Node findPath(Node root, Object target) {

            Node result = null;

            for (Node node : root.getChildren().getNodes(true)) {

                final org.netbeans.spi.project.ui.PathFinder pf =

                    node.getLookup().lookup(org.netbeans.spi.project.ui.PathFinder.class);

                if (pf == null) {

                    continue;

                }

                result = pf.findPath(node, target);

                if (result != null) {

                    break;

                }

            }

            return result;

        }

    }

import org.netbeans.api.java.project.JavaProjectConstants;

import org.netbeans.api.project.SourceGroup;

    @Override

    private static boolean isOtherProjectSource(

            @NonNull final FileObject fo,

            @NonNull final Project me) {

        final Project owner = FileOwnerQuery.getOwner(fo);

        if (owner == null) {

            return false;

        }

        if (me.equals(owner)) {

            return false;

        }

        for (SourceGroup sg : ProjectUtils.getSources(owner).getSourceGroups(JavaProjectConstants.SOURCES_TYPE_JAVA)) {

            if (FileUtil.isParentOf(sg.getRootFolder(), fo)) {

                return true;

            }

        }

        return false;

    }

        @Override

import org.netbeans.spi.project.ui.PathFinder;

        return null;

        @Override

        <change id="PathFinder">

            <api name="general"/>

            <summary>Extracted <code>findPath</code> method into a new interface <code>PathFinder</code></summary>

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

            <date day="12" month="7" year="2012"/>

            <author login="tzezula"/>

            <compatibility addition="yes"/>

            <description>

                <p>

                    Extracted <code>findPath</code> method from <code>LogicalViewProvider</code> into a new interface <code>PathFinder</code>.

                    A new <code>PathFinder</code> simplifies delegation of <code>findPath</code> method.

                </p>

            </description>

            <class package="org.netbeans.spi.project.ui" name="PathFinder"/>

            <issue number="208241"/>

        </change>

/*

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

 *

 * Copyright 2012 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 2012 Sun Microsystems, Inc.

 */

package org.netbeans.spi.project.ui;

import org.openide.nodes.Node;

/**

 * Ability to find a subnode representing a target.

 * Extended by the {@link LogicalViewProvider}.

 * @author Tomas Zezula

 * @since 1.59

 */

public interface PathFinder {

    /**

    * Try to find a given node in the logical view.

    * If some node within the logical view tree has the supplied object

    * in its lookup, it ought to be returned if that is practical.

    * If there are multiple such nodes, the one most suitable for display

    * to the user should be returned.<BR>

    * This may be used to select nodes corresponding to files, etc.

    * The following constraint should hold:

    * <pre>

    * private static boolean isAncestor(Node root, Node n) {

    *     if (n == null) return false;

    *     if (n == root) return true;

    *     return isAncestor(root, n.getParentNode());

    * }

    * // ...

    * Node root = ...;

    * Object target = ...;

    * LogicalViewProvider lvp = ...;

    * Node n = lvp.findPath(root, target);

    * if (n != null) {

    *     assert isAncestor(root, n);

    *     Lookup.Template tmpl = new Lookup.Template(null, null, target);

    *     Collection res = n.getLookup().lookup(tmpl).allInstances();

    *     assert Collections.singleton(target).equals(new HashSet(res));

    * }

    * </pre>

    * @param root a root node. E.g. a node from {@link #createLogicalView} or some wapper

    *        (FilterNode) around the node. The provider of the functionality is

    *        responsible for finding the appropriate node in the wrapper's children.

    * @param target a target cookie, such as a {@link org.openide.loaders.DataObject}

    * @return a subnode with that cookie, or null

    */

    Node findPath(Node root, Object target);

}