<?xml version="1.0" encoding="UTF-8"?>

<!--

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

Copyright 1997-2010 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]"

Contributor(s):

The Original Software is NetBeans. The Initial Developer of the Original

Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun

Microsystems, Inc. All Rights Reserved.

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.

-->

<?xml-stylesheet href="../nbbuild/javadoctools/apichanges.xsl" type="text/xsl"?>

<!DOCTYPE apichanges PUBLIC "-//NetBeans//DTD API changes list 1.0//EN" "../nbbuild/javadoctools/apichanges.dtd">

<!-- INFO FOR PEOPLE ADDING CHANGES:

[most of contents snipped - see openide's apichanges for how-to instructions]

<change>

    <api name="compiler"/>

    <summary>Some brief description here, can use <b>XHTML</b></summary>

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

    <date day="13" month="6" year="2001"/>

    <author login="jrhacker"/>

    <compatibility addition="yes"/>

    <description>

        The main description of the change here.

        Again can use full <b>XHTML</b> as needed.

    </description>

    <class package="org.openide.compiler" name="DoWhatIWantCompiler"/>

    <issue number="14309"/>

</change>

-->

<apichanges>

<!-- First, a list of API names you may use: -->

<apidefs>

        <apidef name="general">Java Source Firend API</apidef>

</apidefs>

<!-- ACTUAL CHANGES BEGIN HERE: -->

<changes>

        <change id="JavaIndexerPlugin">

            <api name="general"/>

            <summary>Added a possibility to plug into Java source indexing</summary>

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

            <date day="29" month="8" year="2011"/>

            <author login="tzezula"/>

            <compatibility addition="yes" modification="no" semantic="compatible" source="compatible" binary="compatible"/>

            <description>

                <p>

                    Added a possibility to plug into Java source indexing. The indexer plugin is called

                    on fully attributed compilation unit tree processed by <code>JavaCustomIndexer</code>.

                    Because the parsing and attribution of Java source was already done by JavaCustomIndexer

                    the plugin does not introduce any performance impact.

                </p>

            </description>

            <class package="org.netbeans.modules.java.preprocessorbridge.spi" name="JavaIndexerPlugin"/>

        </change>

</changes>

  <!-- Now the surrounding HTML text and document structure: -->

  <htmlcontents>

<!--

                            NO NO NO NO NO!

         ==============>    DO NOT EDIT ME!  <======================

          AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT

                SEE xml/api/doc/changes/apichanges.xml

-->

    <head>

      <title>Java Source Friend API changes by date</title>

      <link rel="stylesheet" href="prose.css" type="text/css"/>

    </head>

    <body>

<p class="overviewlink"><a href="overview-summary.html">Overview</a></p>

<h1>Introduction</h1>

<p>This document lists changes made to the Java Source Friend APIs. Please ask on the

<code>dev@java.netbeans.org</code> or <code>nbdev@netbeans.org</code>

mailing list if you have any questions about the details of a

change, or are wondering how to convert existing code to be compatible.</p>

      <hr/><standard-changelists module-code-name="org.netbeans.modules.java.preprocessorbridge"/>

      <hr/><p>@FOOTER@</p>

    </body>

  </htmlcontents>

</apichanges>

                    <code-name-base>org.netbeans.api.annotations.common</code-name-base>

                    <build-prerequisite/>

                    <compile-dependency/>

                    <run-dependency>

                        <release-version>1</release-version>

                        <specification-version>1.10</specification-version>

                    </run-dependency>

                </dependency>

                <dependency>

/*

 * 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.java.preprocessorbridge.spi;

import com.sun.source.tree.CompilationUnitTree;

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

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

import org.openide.filesystems.FileObject;

import org.openide.util.Lookup;

/**

 *

 * JavaCustomIndexer plugin called during scan on fully attributed trees.

 * @since 1.20

 * @author Tomas Zezula

 */

public interface JavaIndexerPlugin {

    /**

     * Process given attributed compilation unit.

     * @param toProcess the compilation unit to process

     * @param services a {@link Lookup} containing javac services (Elements, Types, Trees)

     */

    public void process (@NonNull CompilationUnitTree toProcess, @NonNull Lookup services);

    /**

     * Factory to create JavaIndexerPlugin.

     * The factory instance should be registered in mime lookup.

     */

    public interface Factory {

        /**

         * Creates a new instance of {@link JavaIndexerPlugin}.

         * @param root the source root for which the plugin is created

         * @return the new instance of {@link JavaIndexerPlugin} or null

         * if the factory does not handle given source root

         */

        @CheckForNull

        JavaIndexerPlugin create(@NonNull FileObject root);

    }

}