View Javadoc
1   /*
2    * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved.
3    * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4    *
5    * This code is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU General Public License version 2 only, as
7    * published by the Free Software Foundation.  Oracle designates this
8    * particular file as subject to the "Classpath" exception as provided
9    * by Oracle in the LICENSE file that accompanied this code.
10   *
11   * This code is distributed in the hope that it will be useful, but WITHOUT
12   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13   * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14   * version 2 for more details (a copy is included in the LICENSE file that
15   * accompanied this code).
16   *
17   * You should have received a copy of the GNU General Public License version
18   * 2 along with this work; if not, write to the Free Software Foundation,
19   * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20   *
21   * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22   * or visit www.oracle.com if you need additional information or have any
23   * questions.
24   */
25  
26  package java.util.prefs;
27  import java.util.*;
28  
29  /**
30   * A factory object that generates Preferences objects.  Providers of
31   * new {@link Preferences} implementations should provide corresponding
32   * <tt>PreferencesFactory</tt> implementations so that the new
33   * <tt>Preferences</tt> implementation can be installed in place of the
34   * platform-specific default implementation.
35   *
36   * <p><strong>This class is for <tt>Preferences</tt> implementers only.
37   * Normal users of the <tt>Preferences</tt> facility should have no need to
38   * consult this documentation.</strong>
39   *
40   * @author  Josh Bloch
41   * @see     Preferences
42   * @since   1.4
43   */
44  public interface PreferencesFactory {
45      /**
46       * Returns the system root preference node.  (Multiple calls on this
47       * method will return the same object reference.)
48       * @return the system root preference node
49       */
50      Preferences systemRoot();
51  
52      /**
53       * Returns the user root preference node corresponding to the calling
54       * user.  In a server, the returned value will typically depend on
55       * some implicit client-context.
56       * @return the user root preference node corresponding to the calling
57       * user
58       */
59      Preferences userRoot();
60  }