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

<!--

DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

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

-->

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

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

<!--

INFO FOR PEOPLE ADDING CHANGES:

Check the DTD (apichanges.dtd) for details on the syntax. You do not

need to regenerate the HTML, as this is part of Javadoc generation; just

change the XML. Rough syntax of a change (several parts optional):

<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>

Also permitted elements: <package>, <branch>. <version> is API spec

version, recommended for all new changes. <compatibility> should say

if things were added/modified/deprecated/etc. and give all information

related to upgrading old code. List affected top-level classes and

link to issue numbers if applicable. See the DTD for more details.

Changes need not be in any particular order, they are sorted in various

ways by the stylesheet anyway.

Dates are assumed to mean "on the trunk". If you *also* make the same

change on a stabilization branch, use the <branch> tag to indicate this

and explain why the change was made on a branch in the <description>.

Please only change this file on the trunk! Rather: you can change it

on branches if you want, but these changes will be ignored; only the

trunk version of this file is important.

Deprecations do not count as incompatible, assuming that code using the

deprecated calls continues to see their documented behavior. But do

specify deprecation="yes" in <compatibility>.

This file is not a replacement for Javadoc: it is intended to list changes,

not describe the complete current behavior, for which ordinary documentation

is the proper place.

-->

<apichanges>

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

    <apidefs>

        <apidef name="spi.quicksearch">Quick Search API</apidef>

    </apidefs>

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

    <changes>

        <change id="SearchRequest.getMaxResults">

            <api name="spi.quicksearch"/>

            <summary>Add methods for working with results limit</summary>

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

            <date day="23" month="5" year="2014"/>

            <author login="jhavlin"/>

            <compatibility addition="yes"/>

            <description>

                <p>

                    Some search providers can perform some optimizations if

                    they know what is the limit on number of search results

                    in advance. So there is new method

                    SearchRequest.getMaxResults to retrieve the current limit,

                    and method SearchResponse.setMoreResults to explicitly

                    inform that there are more results not added to the

                    SearchResponse.

                </p>

            </description>

            <class package="org.netbeans.spi.quicksearch" name="SearchRequest"/>

            <class package="org.netbeans.spi.quicksearch" name="SearchResponse"/>

            <issue number="244432"/>

        </change>

    </changes>

    <htmlcontents>

        <!--

                            NO NO NO NO NO!

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

          AUTOMATICALLY GENERATED FROM APICHANGES.XML, DO NOT EDIT

                SEE openide/io/api/doc/changes/changes.xml

        -->

        <head>

            <title>Change History for the Quick Search API</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 <a href="@org-netbeans-spi-quicksearch@/index.html">Quick Search API</a>.</p>

            <!-- The actual lists of changes, as summaries and details: -->

            <hr/>

            <standard-changelists module-code-name="org.netbeans.spi.quicksearch"/>

            <hr/>

            <p>@FOOTER@</p>

        </body>

    </htmlcontents>

</apichanges>

javadoc.apichanges=${basedir}/apichanges.xml

import org.netbeans.spi.quicksearch.SearchRequest;

import sun.awt.FontConfiguration;

    /**

     * Inform that there are more results to add, but they won't be added

     * because of exceeded limit on number of items.

     *

     * @see SearchRequest#getMaxResults().

     */

    public void setMoreResults() {

        if (!allResults) {

            moreResults = true;

        }

    }

        SearchRequest sRequest = Accessor.DEFAULT.createRequest(commands[1], null,

                (allResults ? CategoryResult.ALL_MAX_RESULTS : CategoryResult.MAX_RESULTS));

        this.maxResults = maxResults;

    /**

     * Get maximal number of results that can be displayed under current

     * circumstances. You can use this information to optimize you search. But

     * remember that it is sometimes important to know whether there are more

     * results than the current limit L. So either add L+1 results, or call

     * method {@link SearchResponse#setMoreResults()}.

     *

     * @return The current limit on number of displayable results.

     * @see SearchResponse#setMoreResults()

     * @since spi.quicksearch/1.24

     */

    public int getMaxResults() {

        return maxResults;

    }

    /**

     * Inform that there are more results to add, but they won't be added

     * because of exceeded limit on number of items.

     *

     * @see SearchRequest#getMaxResults().

     * @since spi.quicksearch/1.24

     */

    public void setMoreResults() {

        catResult.setMoreResults();

    }