KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > modules > openide > util > PreferencesProvider


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.modules.openide.util;
21
22 import java.util.prefs.Preferences JavaDoc;
23
24 /**
25  *
26  * @author Radek Matous
27  */

28 public interface PreferencesProvider {
29     /**
30      * Returns user preference node. {@link Preferences#absolutePath} of such
31      * a node depends whether class provided as a parameter was loaded as a part of any module
32      * or not. If so, then absolute path corresponds to slashified code name base of module.
33      * If not, then absolute path corresponds to class's package.
34      *
35      * @param cls the class for which a user preference node is desired.
36      * @return the user preference node
37      */

38     Preferences JavaDoc preferencesForModule(Class JavaDoc cls);
39     
40     /**
41      * Returns the root preference node.
42      *
43      * @return the root preference node.
44      */

45     Preferences JavaDoc preferencesRoot();
46 }
47
Popular Tags