CacheDirectoryProvider


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.project;
21  
22  import java.io.IOException  ;
23  import org.openide.filesystems.FileObject;
24  
25  /**
26   * Ability for a project to permit other modules to store arbitrary cache
27   * data associated with the project.
28   * @see org.netbeans.api.project.Project#getLookup
29   * @author Jesse Glick
30   */
31  public interface CacheDirectoryProvider {
32  
33      /**
34       * Get a directory in which modules may store disposable cached information
35       * about the project, such as an index of classes it contains.
36       * This directory should be considered non-sharable by
37       * {@link org.netbeans.api.queries.SharabilityQuery}.
38       * Modules are responsible for preventing name clashes in this directory by
39       * using sufficiently unique names for child files and folders.
40       * @return a cache directory
41       * @throws IOException if it cannot be created or loaded
42       */
43      FileObject getCacheDirectory() throws IOException  ;
44  
45  }
46
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags