OccurrencesFinder


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.gsf;
21  
22  import java.util.Map  ;
23  import org.netbeans.api.gsf.OffsetRange;
24  
25  /**
26   * A CancellableTask responsible for computing the set of highlights matching
27   * occurrences of the same program element as the one under the caret.
28   * 
29   * @author Tor Norbye
30   */
31  public interface OccurrencesFinder extends CancellableTask<CompilationInfo> {
32      /**
33       * Set the caret position for which the current program element should
34       * be computed. This method will be called before {@link #run} is called
35       * to produce the set of highlights.
36       */
37      public abstract void setCaretPosition(int position);
38      
39      /**
40       * Return a set of occurrence highlights computed by the last call to
41       * {@link #run}.
42       */
43      public abstract Map  <OffsetRange, ColoringAttributes> getOccurrences();
44  }
45
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags