VisibilityQueryImplementation


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.spi.queries;
21  
22  import org.openide.filesystems.FileObject;
23  
24  import javax.swing.event.ChangeListener  ;
25  
26  /**
27   * Determine whether files should be hidden in views presented to the user.
28   * <p>
29   * Global lookup is used to find all instances of VisibilityQueryImplementation.
30   * </p>
31   * <p>
32   * Threading note: implementors should avoid acquiring locks that might be held
33   * by other threads. Generally treat this interface similarly to SPIs in
34   * {@link org.openide.filesystems} with respect to threading semantics.
35   * </p>
36   * @see org.netbeans.api.queries.VisibilityQuery
37   * @author Radek Matous 
38   */ 
39  public interface VisibilityQueryImplementation {
40      /**
41       * Check whether a file is recommended to be visible.
42       * @param file a file to considered
43       * @return true if it is recommended to display this file
44       */ 
45      boolean isVisible(FileObject file);
46  
47      /**
48       * Add a listener to changes.
49       * @param l a listener to add
50       */
51      void addChangeListener(ChangeListener   l);
52          
53      /**
54       * Stop listening to changes.
55       * @param l a listener to remove
56       */
57      void removeChangeListener(ChangeListener   l);    
58  }
59
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags