KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > java > source > query > QueryResult


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20 package org.netbeans.api.java.source.query;
21
22 /**
23  * A result returned by a Jackpot query.
24  */
25 public interface QueryResult {
26     /**
27      * Returns a description of the Query that returned this result.
28      *
29      * @return the Query's description.
30      */
31     public String JavaDoc getQueryDescription();
32     
33     /**
34      * Return the SourceSelection affected by this result.
35      *
36      * @return the selected element.
37      */
38     public SourceSelection getSourceSelection();
39     
40     /**
41      * Returns any note included with this result.
42      *
43      * @return the note attached to this result.
44      */
45     public String JavaDoc getNote();
46 }
47
Popular Tags