151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/* 22c87ad3a45cecf9e344487cad1abfdebe79f2c7cNarayan Kamath * Copyright (C) 2014 The Android Open Source Project 3bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * Copyright (c) 2000, 2013, Oracle and/or its affiliates. All rights reserved. 451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is free software; you can redistribute it and/or modify it 751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under the terms of the GNU General Public License version 2 only, as 851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * published by the Free Software Foundation. Oracle designates this 951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * particular file as subject to the "Classpath" exception as provided 1051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by Oracle in the LICENSE file that accompanied this code. 1151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This code is distributed in the hope that it will be useful, but WITHOUT 1351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * version 2 for more details (a copy is included in the LICENSE file that 1651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * accompanied this code). 1751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * You should have received a copy of the GNU General Public License version 1951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2 along with this work; if not, write to the Free Software Foundation, 2051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 2251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or visit www.oracle.com if you need additional information or have any 2451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * questions. 2551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 2651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipackage java.util.prefs; 2851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 2951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.util.*; 3051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.io.*; 3151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.AccessController; 3251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.security.PrivilegedAction; 3351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski// These imports needed only as a workaround for a JavaDoc bug 3451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.Integer; 3551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.Long; 3651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.Float; 3751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskiimport java.lang.Double; 3851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 3951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski/** 4051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This class provides a skeletal implementation of the {@link Preferences} 4151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * class, greatly easing the task of implementing it. 4251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p><strong>This class is for <tt>Preferences</tt> implementers only. 4451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Normal users of the <tt>Preferences</tt> facility should have no need to 4551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * consult this documentation. The {@link Preferences} documentation 4651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * should suffice.</strong> 4751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 4851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Implementors must override the nine abstract service-provider interface 4951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (SPI) methods: {@link #getSpi(String)}, {@link #putSpi(String,String)}, 5051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #removeSpi(String)}, {@link #childSpi(String)}, {@link 5151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #removeNodeSpi()}, {@link #keysSpi()}, {@link #childrenNamesSpi()}, {@link 5251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #syncSpi()} and {@link #flushSpi()}. All of the concrete methods specify 5351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * precisely how they are implemented atop these SPI methods. The implementor 5451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * may, at his discretion, override one or more of the concrete methods if the 5551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * default implementation is unsatisfactory for any reason, such as 5651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * performance. 5751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 5851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The SPI methods fall into three groups concerning exception 5951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * behavior. The <tt>getSpi</tt> method should never throw exceptions, but it 6051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * doesn't really matter, as any exception thrown by this method will be 6151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * intercepted by {@link #get(String,String)}, which will return the specified 6251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * default value to the caller. The <tt>removeNodeSpi, keysSpi, 6351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * childrenNamesSpi, syncSpi</tt> and <tt>flushSpi</tt> methods are specified 6451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to throw {@link BackingStoreException}, and the implementation is required 6551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to throw this checked exception if it is unable to perform the operation. 6651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * The exception propagates outward, causing the corresponding API method 6751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to fail. 6851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 6951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The remaining SPI methods {@link #putSpi(String,String)}, {@link 7051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #removeSpi(String)} and {@link #childSpi(String)} have more complicated 7151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * exception behavior. They are not specified to throw 7251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>BackingStoreException</tt>, as they can generally obey their contracts 7351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * even if the backing store is unavailable. This is true because they return 7451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * no information and their effects are not required to become permanent until 7551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a subsequent call to {@link Preferences#flush()} or 7651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#sync()}. Generally speaking, these SPI methods should not 7751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * throw exceptions. In some implementations, there may be circumstances 7851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under which these calls cannot even enqueue the requested operation for 7951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * later processing. Even under these circumstances it is generally better to 8051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * simply ignore the invocation and return, rather than throwing an 8151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * exception. Under these circumstances, however, all subsequent invocations 8251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of <tt>flush()</tt> and <tt>sync</tt> should return <tt>false</tt>, as 8351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returning <tt>true</tt> would imply that all previous operations had 8451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * successfully been made permanent. 8551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 8651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>There is one circumstance under which <tt>putSpi, removeSpi and 8751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * childSpi</tt> <i>should</i> throw an exception: if the caller lacks 8851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sufficient privileges on the underlying operating system to perform the 8951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * requested operation. This will, for instance, occur on most systems 9051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if a non-privileged user attempts to modify system preferences. 9151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (The required privileges will vary from implementation to 9251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementation. On some implementations, they are the right to modify the 9351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * contents of some directory in the file system; on others they are the right 9451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to modify contents of some key in a registry.) Under any of these 9551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * circumstances, it would generally be undesirable to let the program 9651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * continue executing as if these operations would become permanent at a later 9751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * time. While implementations are not required to throw an exception under 9851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * these circumstances, they are encouraged to do so. A {@link 9951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * SecurityException} would be appropriate. 10051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Most of the SPI methods require the implementation to read or write 10251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * information at a preferences node. The implementor should beware of the 10351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * fact that another VM may have concurrently deleted this node from the 10451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * backing store. It is the implementation's responsibility to recreate the 10551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node if it has been deleted. 10651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 10751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Implementation note: In Sun's default <tt>Preferences</tt> 10851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementations, the user's identity is inherited from the underlying 10951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * operating system and does not change for the lifetime of the virtual 11051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * machine. It is recognized that server-side <tt>Preferences</tt> 11151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementations may have the user identity change from request to request, 11251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implicitly passed to <tt>Preferences</tt> methods via the use of a 11351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * static {@link ThreadLocal} instance. Authors of such implementations are 11451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <i>strongly</i> encouraged to determine the user at the time preferences 11551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * are accessed (for example by the {@link #get(String,String)} or {@link 11651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #put(String,String)} method) rather than permanently associating a user 11751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with each <tt>Preferences</tt> instance. The latter behavior conflicts 11851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with normal <tt>Preferences</tt> usage and would lead to great confusion. 11951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 12051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @author Josh Bloch 12151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see Preferences 12251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @since 1.4 12351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebskipublic abstract class AbstractPreferences extends Preferences { 12551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 12651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Our name relative to parent. 12751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 12851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String name; 12951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Our absolute path name. 13251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final String absolutePath; 13451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 13551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 13651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Our parent node. 13751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 13851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski final AbstractPreferences parent; 13951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 14151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Our root node. 14251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 14351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private final AbstractPreferences root; // Relative to this node 14451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 14551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 14651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This field should be <tt>true</tt> if this node did not exist in the 14751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * backing store prior to the creation of this object. The field 14851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is initialized to false, but may be set to true by a subclass 14951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * constructor (and should not be modified thereafter). This field 15051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * indicates whether a node change event should be fired when 15151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * creation is complete. 15251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected boolean newNode = false; 15451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 15551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 15651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * All known unremoved children of this node. (This "cache" is consulted 15751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * prior to calling childSpi() or getChild(). 15851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 15951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Map<String, AbstractPreferences> kidCache = new HashMap<>(); 16051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 16151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 16251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This field is used to keep track of whether or not this node has 16351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been removed. Once it's set to true, it will never be reset to false. 16451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 16551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private boolean removed = false; 16651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 16751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 16851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registered preference change listeners. 16951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 170e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath private final ArrayList<PreferenceChangeListener> prefListeners = new ArrayList<>(); 17151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 17251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 17351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Registered node change listeners. 17451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 175e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath private final ArrayList<NodeChangeListener> nodeListeners = new ArrayList<>(); 17651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 17751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 17851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * An object whose monitor is used to lock this node. This object 17951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is used in preference to the node itself to reduce the likelihood of 18051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * intentional or unintentional denial of service due to a locked node. 18151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * To avoid deadlock, a node is <i>never</i> locked by a thread that 18251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * holds a lock on a descendant of that node. 18351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 18451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected final Object lock = new Object(); 18551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 18651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 18751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Creates a preference node with the specified parent and the specified 18851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name relative to its parent. 18951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 19051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param parent the parent of this preference node, or null if this 19151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is the root. 19251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param name the name of this preference node, relative to its parent, 19351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or <tt>""</tt> if this is the root. 19451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>name</tt> contains a slash 19551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (<tt>'/'</tt>), or <tt>parent</tt> is <tt>null</tt> and 19651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * name isn't <tt>""</tt>. 19751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 19851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected AbstractPreferences(AbstractPreferences parent, String name) { 19951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (parent==null) { 20051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!name.equals("")) 20151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Root name '"+name+ 20251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "' must be \"\""); 20351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.absolutePath = "/"; 20451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski root = this; 20551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 20651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (name.indexOf('/') != -1) 20751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Name '" + name + 20851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "' contains '/'"); 20951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (name.equals("")) 21051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Illegal name: empty string"); 21151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 21251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski root = parent.root; 21351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski absolutePath = (parent==root ? "/" + name 21451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski : parent.absolutePath() + "/" + name); 21551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 21651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.name = name; 21751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski this.parent = parent; 21851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 21951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 22051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 22151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>put</tt> method as per the specification in 22251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#put(String,String)}. 22351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 22451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation checks that the key and value are legal, 22551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * obtains this preference node's lock, checks that the node 22651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has not been removed, invokes {@link #putSpi(String,String)}, and if 22751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * there are any preference change listeners, enqueues a notification 22851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * event for processing by the event dispatch thread. 22951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 23051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the specified value is to be associated. 23151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value to be associated with the specified key. 23251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key or value is <tt>null</tt>. 23351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 23451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt> or if <tt>value.length</tt> exceeds 23551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_VALUE_LENGTH</tt>. 23651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 23751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 23851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 23951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void put(String key, String value) { 24051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key==null || value==null) 24151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException(); 24251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key.length() > MAX_KEY_LENGTH) 24351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Key too long: "+key); 24451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value.length() > MAX_VALUE_LENGTH) 24551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Value too long: "+value); 24651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 24751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 24851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 24951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 25051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 25151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski putSpi(key, value); 25251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski enqueuePreferenceChangeEvent(key, value); 25351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 25451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 25551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 25651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 25751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>get</tt> method as per the specification in 25851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#get(String,String)}. 25951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation first checks to see if <tt>key</tt> is 26151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>null</tt> throwing a <tt>NullPointerException</tt> if this is 26251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the case. Then it obtains this preference node's lock, 26351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * checks that the node has not been removed, invokes {@link 26451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #getSpi(String)}, and returns the result, unless the <tt>getSpi</tt> 26551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invocation returns <tt>null</tt> or throws an exception, in which case 26651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this invocation returns <tt>def</tt>. 26751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 26851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned. 26951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 27051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt>. 27151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the value associated with <tt>key</tt>, or <tt>def</tt> 27251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if no value is associated with <tt>key</tt>. 27351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 27451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 27551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. (A 27651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>null</tt> default <i>is</i> permitted.) 27751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 27851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String get(String key, String def) { 27951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (key==null) 28051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException("Null key"); 28151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 28251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 28351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 28451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 28551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String result = null; 28651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 28751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = getSpi(key); 28851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (Exception e) { 28951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes default to be returned 29051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (result==null ? def : result); 29251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 29451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 29551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 29651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>remove(String)</tt> method as per the specification 29751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in {@link Preferences#remove(String)}. 29851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 29951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, 30051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * checks that the node has not been removed, invokes 30151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #removeSpi(String)} and if there are any preference 30251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * change listeners, enqueues a notification event for processing by the 30351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * event dispatch thread. 30451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 30551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose mapping is to be removed from the preference node. 30651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 30751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 308bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * @throws NullPointerException {@inheritDoc}. 30951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 31051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void remove(String key) { 311bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak Objects.requireNonNull(key, "Specified key cannot be null"); 31251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 31351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 31451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 31551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 31651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski removeSpi(key); 31751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski enqueuePreferenceChangeEvent(key, null); 31851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 31951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 32051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 32151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 32251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>clear</tt> method as per the specification in 32351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#clear()}. 32451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 32551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, 32651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invokes {@link #keys()} to obtain an array of keys, and 32751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * iterates over the array invoking {@link #remove(String)} on each key. 32851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 32951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 33051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 33151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 33251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 33351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 33451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 33551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void clear() throws BackingStoreException { 33651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 33751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String[] keys = keys(); 33851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<keys.length; i++) 33951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski remove(keys[i]); 34051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 34151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 34251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 34351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 34451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putInt</tt> method as per the specification in 34551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putInt(String,int)}. 34651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 34751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation translates <tt>value</tt> to a string with 34851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Integer#toString(int)} and invokes {@link #put(String,String)} 34951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the result. 35051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 35151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 35251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 35351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. 35451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 35551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt>. 35651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 35751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 35851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 35951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putInt(String key, int value) { 36051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, Integer.toString(value)); 36151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 36251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 36351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 36451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getInt</tt> method as per the specification in 36551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getInt(String,int)}. 36651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 36751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation invokes {@link #get(String,String) <tt>get(key, 36851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null)</tt>}. If the return value is non-null, the implementation 36951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * attempts to translate it to an <tt>int</tt> with 37051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Integer#parseInt(String)}. If the attempt succeeds, the return 37151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value is returned by this method. Otherwise, <tt>def</tt> is returned. 37251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 37351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as an int. 37451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 37551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 37651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as an int. 37751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the int value represented by the string associated with 37851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 37951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 38051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * an int. 38151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 38251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 38351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. 38451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 38551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public int getInt(String key, int def) { 38651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski int result = def; 38751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 38851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 38951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) 39051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = Integer.parseInt(value); 39151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (NumberFormatException e) { 39251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes specified default to be returned 39351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 39451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 39651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 39751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 39851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 39951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putLong</tt> method as per the specification in 40051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putLong(String,long)}. 40151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 40251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation translates <tt>value</tt> to a string with 40351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Long#toString(long)} and invokes {@link #put(String,String)} 40451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the result. 40551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 40651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 40751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 40851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. 40951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 41051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt>. 41151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 41251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 41351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 41451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putLong(String key, long value) { 41551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, Long.toString(value)); 41651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 41751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 41851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 41951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getLong</tt> method as per the specification in 42051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getLong(String,long)}. 42151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 42251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation invokes {@link #get(String,String) <tt>get(key, 42351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null)</tt>}. If the return value is non-null, the implementation 42451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * attempts to translate it to a <tt>long</tt> with 42551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Long#parseLong(String)}. If the attempt succeeds, the return 42651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value is returned by this method. Otherwise, <tt>def</tt> is returned. 42751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 42851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as a long. 42951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 43051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 43151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as a long. 43251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the long value represented by the string associated with 43351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 43451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 43551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a long. 43651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 43751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 43851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. 43951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 44051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public long getLong(String key, long def) { 44151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski long result = def; 44251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 44351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 44451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) 44551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = Long.parseLong(value); 44651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (NumberFormatException e) { 44751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes specified default to be returned 44851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 44951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 45051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 45151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 45251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 45351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 45451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putBoolean</tt> method as per the specification in 45551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putBoolean(String,boolean)}. 45651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 45751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation translates <tt>value</tt> to a string with 45851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link String#valueOf(boolean)} and invokes {@link #put(String,String)} 45951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the result. 46051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 46151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 46251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 46351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. 46451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 46551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt>. 46651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 46751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 46851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 46951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putBoolean(String key, boolean value) { 47051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, String.valueOf(value)); 47151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 47251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 47351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 47451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getBoolean</tt> method as per the specification in 47551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getBoolean(String,boolean)}. 47651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 47751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation invokes {@link #get(String,String) <tt>get(key, 47851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null)</tt>}. If the return value is non-null, it is compared with 47951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>"true"</tt> using {@link String#equalsIgnoreCase(String)}. If the 48051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * comparison returns <tt>true</tt>, this invocation returns 48151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>true</tt>. Otherwise, the original return value is compared with 48251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>"false"</tt>, again using {@link String#equalsIgnoreCase(String)}. 48351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the comparison returns <tt>true</tt>, this invocation returns 48451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>false</tt>. Otherwise, this invocation returns <tt>def</tt>. 48551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 48651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as a boolean. 48751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 48851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 48951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as a boolean. 49051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the boolean value represented by the string associated with 49151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 49251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 49351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a boolean. 49451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 49551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 49651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. 49751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 49851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean getBoolean(String key, boolean def) { 49951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski boolean result = def; 50051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 50151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) { 50251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value.equalsIgnoreCase("true")) 50351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = true; 50451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski else if (value.equalsIgnoreCase("false")) 50551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = false; 50651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 50751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 50851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 50951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 51051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 51151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 51251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putFloat</tt> method as per the specification in 51351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putFloat(String,float)}. 51451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 51551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation translates <tt>value</tt> to a string with 51651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Float#toString(float)} and invokes {@link #put(String,String)} 51751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the result. 51851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 51951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 52051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 52151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. 52251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 52351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt>. 52451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 52551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 52651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 52751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putFloat(String key, float value) { 52851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, Float.toString(value)); 52951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 53051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 53151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 53251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getFloat</tt> method as per the specification in 53351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getFloat(String,float)}. 53451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 53551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation invokes {@link #get(String,String) <tt>get(key, 53651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null)</tt>}. If the return value is non-null, the implementation 53751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * attempts to translate it to an <tt>float</tt> with 53851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Float#parseFloat(String)}. If the attempt succeeds, the return 53951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value is returned by this method. Otherwise, <tt>def</tt> is returned. 54051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 54151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as a float. 54251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 54351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 54451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as a float. 54551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the float value represented by the string associated with 54651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 54751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 54851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a float. 54951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 55051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 55151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. 55251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 55351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public float getFloat(String key, float def) { 55451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski float result = def; 55551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 55651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 55751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) 55851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = Float.parseFloat(value); 55951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (NumberFormatException e) { 56051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes specified default to be returned 56151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 56251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 56351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 56451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 56551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 56651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 56751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putDouble</tt> method as per the specification in 56851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putDouble(String,double)}. 56951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 57051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation translates <tt>value</tt> to a string with 57151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Double#toString(double)} and invokes {@link #put(String,String)} 57251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * on the result. 57351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 57451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 57551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 57651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key is <tt>null</tt>. 57751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if <tt>key.length()</tt> exceeds 57851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>MAX_KEY_LENGTH</tt>. 57951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 58051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 58151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 58251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putDouble(String key, double value) { 58351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, Double.toString(value)); 58451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 58551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 58651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 58751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getDouble</tt> method as per the specification in 58851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getDouble(String,double)}. 58951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 59051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation invokes {@link #get(String,String) <tt>get(key, 59151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * null)</tt>}. If the return value is non-null, the implementation 59251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * attempts to translate it to an <tt>double</tt> with 59351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Double#parseDouble(String)}. If the attempt succeeds, the return 59451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value is returned by this method. Otherwise, <tt>def</tt> is returned. 59551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 59651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as a double. 59751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 59851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 59951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as a double. 60051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the double value represented by the string associated with 60151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 60251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 60351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a double. 60451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 60551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 60651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. 60751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 60851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public double getDouble(String key, double def) { 60951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski double result = def; 61051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 61151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 61251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) 61351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = Double.parseDouble(value); 61451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (NumberFormatException e) { 61551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes specified default to be returned 61651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 61751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 61851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 61951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 62051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 62151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 62251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>putByteArray</tt> method as per the specification in 62351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#putByteArray(String,byte[])}. 62451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 62551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key with which the string form of value is to be associated. 62651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param value value whose string form is to be associated with key. 62751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if key or value is <tt>null</tt>. 62851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if key.length() exceeds MAX_KEY_LENGTH 62951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or if value.length exceeds MAX_VALUE_LENGTH*3/4. 63051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 63151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 63251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 63351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void putByteArray(String key, byte[] value) { 63451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski put(key, Base64.byteArrayToBase64(value)); 63551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 63651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 63751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 63851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>getByteArray</tt> method as per the specification in 63951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#getByteArray(String,byte[])}. 64051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 64151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param key key whose associated value is to be returned as a byte array. 64251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param def the value to be returned in the event that this 64351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node has no value associated with <tt>key</tt> 64451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * or the associated value cannot be interpreted as a byte array. 64551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the byte array value represented by the string associated with 64651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> in this preference node, or <tt>def</tt> if the 64751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * associated value does not exist or cannot be interpreted as 64851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a byte array. 64951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 65051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 65151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws NullPointerException if <tt>key</tt> is <tt>null</tt>. (A 65251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>null</tt> value for <tt>def</tt> <i>is</i> permitted.) 65351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 65451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public byte[] getByteArray(String key, byte[] def) { 65551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski byte[] result = def; 65651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String value = get(key, null); 65751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 65851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (value != null) 65951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski result = Base64.base64ToByteArray(value); 66051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski catch (RuntimeException e) { 66251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ignoring exception causes specified default to be returned 66351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 66551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return result; 66651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 66751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 66851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 66951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>keys</tt> method as per the specification in 67051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#keys()}. 67151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 67251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, checks that 67351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the node has not been removed and invokes {@link #keysSpi()}. 67451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 67551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return an array of the keys that have an associated value in this 67651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node. 67751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 67851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 67951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 68051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 68151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 68251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 68351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String[] keys() throws BackingStoreException { 68451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 68551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 68651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 68751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 68851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return keysSpi(); 68951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 69051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 69151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 69251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 69351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>children</tt> method as per the specification in 69451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#childrenNames()}. 69551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 69651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, checks that 69751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the node has not been removed, constructs a <tt>TreeSet</tt> initialized 69851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the names of children already cached (the children in this node's 69951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "child-cache"), invokes {@link #childrenNamesSpi()}, and adds all of the 70051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returned child-names into the set. The elements of the tree set are 70151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * dumped into a <tt>String</tt> array using the <tt>toArray</tt> method, 70251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and this array is returned. 70351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 70451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the names of the children of this preference node. 70551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 70651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 70751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 70851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 70951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 71051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #cachedChildren() 71151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 71251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String[] childrenNames() throws BackingStoreException { 71351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 71451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 71551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 71651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 71751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski Set<String> s = new TreeSet<>(kidCache.keySet()); 71851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (String kid : childrenNamesSpi()) 71951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski s.add(kid); 72051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return s.toArray(EMPTY_STRING_ARRAY); 72151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 72251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 72351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 72451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final String[] EMPTY_STRING_ARRAY = new String[0]; 72551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 72651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 72751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns all known unremoved children of this node. 72851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 72951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return all known unremoved children of this node. 73051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 73151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected final AbstractPreferences[] cachedChildren() { 73251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return kidCache.values().toArray(EMPTY_ABSTRACT_PREFS_ARRAY); 73351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 73451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 73551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final AbstractPreferences[] EMPTY_ABSTRACT_PREFS_ARRAY 73651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski = new AbstractPreferences[0]; 73751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 73851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 73951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>parent</tt> method as per the specification in 74051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#parent()}. 74151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 74251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, checks that 74351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the node has not been removed and returns the parent value that was 74451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * passed to this node's constructor. 74551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 74651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the parent of this preference node. 74751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 74851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 74951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 75051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Preferences parent() { 75151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 75251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 75351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 75451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 75551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return parent; 75651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 75751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 75851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 75951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 76051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>node</tt> method as per the specification in 76151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#node(String)}. 76251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 76351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock and checks 76451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that the node has not been removed. If <tt>path</tt> is <tt>""</tt>, 76551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this node is returned; if <tt>path</tt> is <tt>"/"</tt>, this node's 76651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * root is returned. If the first character in <tt>path</tt> is 76751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not <tt>'/'</tt>, the implementation breaks <tt>path</tt> into 76851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * tokens and recursively traverses the path from this node to the 76951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * named node, "consuming" a name and a slash from <tt>path</tt> at 77051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * each step of the traversal. At each step, the current node is locked 77151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and the node's child-cache is checked for the named node. If it is 77251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not found, the name is checked to make sure its length does not 77351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * exceed <tt>MAX_NAME_LENGTH</tt>. Then the {@link #childSpi(String)} 77451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is invoked, and the result stored in this node's child-cache. 77551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * If the newly created <tt>Preferences</tt> object's {@link #newNode} 77651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * field is <tt>true</tt> and there are any node change listeners, 77751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a notification event is enqueued for processing by the event dispatch 77851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * thread. 77951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 78051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>When there are no more tokens, the last value found in the 78151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * child-cache or returned by <tt>childSpi</tt> is returned by this 78251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method. If during the traversal, two <tt>"/"</tt> tokens occur 78351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * consecutively, or the final token is <tt>"/"</tt> (rather than a name), 78451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * an appropriate <tt>IllegalArgumentException</tt> is thrown. 78551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 78651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> If the first character of <tt>path</tt> is <tt>'/'</tt> 78751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (indicating an absolute path name) this preference node's 78851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * lock is dropped prior to breaking <tt>path</tt> into tokens, and 78951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this method recursively traverses the path starting from the root 79051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (rather than starting from this node). The traversal is otherwise 79151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * identical to the one described for relative path names. Dropping 79251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the lock on this node prior to commencing the traversal at the root 79351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node is essential to avoid the possibility of deadlock, as per the 79451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #lock locking invariant}. 79551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 79651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param path the path name of the preference node to return. 79751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the specified preference node. 79851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if the path name is invalid (i.e., 79951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it contains multiple consecutive slash characters, or ends 80051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with a slash character and is more than one character long). 80151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 80251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 80351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 80451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Preferences node(String path) { 80551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 80651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 80751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 80851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.equals("")) 80951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return this; 81051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.equals("/")) 81151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return root; 81251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.charAt(0) != '/') 81351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return node(new StringTokenizer(path, "/", true)); 81451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 81551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 81651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Absolute path. Note that we've dropped our lock to avoid deadlock 81751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return root.node(new StringTokenizer(path.substring(1), "/", true)); 81851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 81951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 82051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 82151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * tokenizer contains <name> {'/' <name>}* 82251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 82351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private Preferences node(StringTokenizer path) { 82451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String token = path.nextToken(); 82551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (token.equals("/")) // Check for consecutive slashes 82651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Consecutive slashes in path"); 82751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 82851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski AbstractPreferences child = kidCache.get(token); 82951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (child == null) { 83051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (token.length() > MAX_NAME_LENGTH) 83151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException( 83251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski "Node name " + token + " too long"); 83351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski child = childSpi(token); 83451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (child.newNode) 83551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski enqueueNodeAddedEvent(child); 83651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski kidCache.put(token, child); 83751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 83851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!path.hasMoreTokens()) 83951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return child; 84051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski path.nextToken(); // Consume slash 84151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!path.hasMoreTokens()) 84251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Path ends with slash"); 84351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return child.node(path); 84451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 84551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 84651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 84751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 84851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>nodeExists</tt> method as per the specification in 84951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#nodeExists(String)}. 85051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 85151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation is very similar to {@link #node(String)}, 85251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * except that {@link #getChild(String)} is used instead of {@link 85351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #childSpi(String)}. 85451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 85551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param path the path name of the node whose existence is to be checked. 85651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return true if the specified node exists. 85751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 85851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 85951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 86051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalArgumentException if the path name is invalid (i.e., 86151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it contains multiple consecutive slash characters, or ends 86251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with a slash character and is more than one character long). 86351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 86451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method and 86551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>pathname</tt> is not the empty string (<tt>""</tt>). 86651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 86751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean nodeExists(String path) 86851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws BackingStoreException 86951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 87051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 87151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.equals("")) 87251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return !removed; 87351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 87451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 87551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.equals("/")) 87651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 87751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (path.charAt(0) != '/') 87851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return nodeExists(new StringTokenizer(path, "/", true)); 87951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 88051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 88151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Absolute path. Note that we've dropped our lock to avoid deadlock 88251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return root.nodeExists(new StringTokenizer(path.substring(1), "/", 88351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski true)); 88451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 88551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 88651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 88751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * tokenizer contains <name> {'/' <name>}* 88851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 88951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private boolean nodeExists(StringTokenizer path) 89051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws BackingStoreException 89151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 89251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String token = path.nextToken(); 89351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (token.equals("/")) // Check for consecutive slashes 89451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Consecutive slashes in path"); 89551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 89651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski AbstractPreferences child = kidCache.get(token); 89751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (child == null) 89851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski child = getChild(token); 89951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (child==null) 90051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return false; 90151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!path.hasMoreTokens()) 90251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return true; 90351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski path.nextToken(); // Consume slash 90451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!path.hasMoreTokens()) 90551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Path ends with slash"); 90651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return child.nodeExists(path); 90751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 90851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 90951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 91051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 91151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 91251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>removeNode()</tt> method as per the specification in 91351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#removeNode()}. 91451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 91551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation checks to see that this node is the root; if so, 91651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it throws an appropriate exception. Then, it locks this node's parent, 91751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * and calls a recursive helper method that traverses the subtree rooted at 91851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this node. The recursive method locks the node on which it was called, 91951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * checks that it has not already been removed, and then ensures that all 92051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of its children are cached: The {@link #childrenNamesSpi()} method is 92151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invoked and each returned child name is checked for containment in the 92251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * child-cache. If a child is not already cached, the {@link 92351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * #childSpi(String)} method is invoked to create a <tt>Preferences</tt> 92451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * instance for it, and this instance is put into the child-cache. Then 92551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the helper method calls itself recursively on each node contained in its 92651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * child-cache. Next, it invokes {@link #removeNodeSpi()}, marks itself 92751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * as removed, and removes itself from its parent's child-cache. Finally, 92851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if there are any node change listeners, it enqueues a notification 92951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * event for processing by the event dispatch thread. 93051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 93151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Note that the helper method is always invoked with all ancestors up 93251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to the "closest non-removed ancestor" locked. 93351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 93451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has already 93551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been removed with the {@link #removeNode()} method. 93651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws UnsupportedOperationException if this method is invoked on 93751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the root node. 93851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 93951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 94051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 94151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 94251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void removeNode() throws BackingStoreException { 94351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (this==root) 94451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new UnsupportedOperationException("Can't remove the root!"); 94551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(parent.lock) { 94651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski removeNode2(); 94751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski parent.kidCache.remove(name); 94851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 94951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 95051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 95151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /* 95251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Called with locks on all nodes on path from parent of "removal root" 95351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * to this (including the former but excluding the latter). 95451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 95551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void removeNode2() throws BackingStoreException { 95651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 95751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 95851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node already removed."); 95951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 96051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Ensure that all children are cached 96151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String[] kidNames = childrenNamesSpi(); 96251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<kidNames.length; i++) 96351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (!kidCache.containsKey(kidNames[i])) 96451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski kidCache.put(kidNames[i], childSpi(kidNames[i])); 96551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 96651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Recursively remove all cached children 96751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (Iterator<AbstractPreferences> i = kidCache.values().iterator(); 96851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski i.hasNext();) { 96951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 97051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski i.next().removeNode2(); 97151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski i.remove(); 97251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (BackingStoreException x) { } 97351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 97451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 97551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Now we have no descendants - it's time to die! 97651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski removeNodeSpi(); 97751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski removed = true; 97851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski parent.enqueueNodeRemovedEvent(this); 97951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 98051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 98151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 98251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 98351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>name</tt> method as per the specification in 98451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#name()}. 98551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 98651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation merely returns the name that was 98751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * passed to this node's constructor. 98851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 98951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return this preference node's name, relative to its parent. 99051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 99151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String name() { 99251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return name; 99351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 99451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 99551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 99651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>absolutePath</tt> method as per the specification in 99751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#absolutePath()}. 99851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 99951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation merely returns the absolute path name that 100051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * was computed at the time that this node was constructed (based on 100151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the name that was passed to this node's constructor, and the names 100251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that were passed to this node's ancestors' constructors). 100351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 100451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return this preference node's absolute path name. 100551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 100651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String absolutePath() { 100751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return absolutePath; 100851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 100951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 101051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 101151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>isUserNode</tt> method as per the specification in 101251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#isUserNode()}. 101351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 101451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation compares this node's root node (which is stored 101551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * in a private field) with the value returned by 101651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#userRoot()}. If the two object references are 101751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * identical, this method returns true. 101851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 101951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> if this preference node is in the user 102051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference tree, <tt>false</tt> if it's in the system 102151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference tree. 102251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 102351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public boolean isUserNode() { 102451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return AccessController.doPrivileged( 102551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski new PrivilegedAction<Boolean>() { 102651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public Boolean run() { 102751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return root == Preferences.userRoot(); 102851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 102951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski }).booleanValue(); 103051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 103151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 103251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void addPreferenceChangeListener(PreferenceChangeListener pcl) { 103351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (pcl==null) 103451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException("Change listener is null."); 103551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 103651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 103751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 103851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1039e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath prefListeners.add(pcl); 104051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 104151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski startEventDispatchThreadIfNecessary(); 104251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 104351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 104451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void removePreferenceChangeListener(PreferenceChangeListener pcl) { 104551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 104651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 104751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 104851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1049e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath if (!prefListeners.contains(pcl)) { 105051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Listener not registered."); 1051e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath } 1052e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath 1053e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath prefListeners.remove(pcl); 105451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 105551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 105651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 105751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void addNodeChangeListener(NodeChangeListener ncl) { 105851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (ncl==null) 105951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new NullPointerException("Change listener is null."); 106051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 106151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 106251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 106351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1064e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath nodeListeners.add(ncl); 106551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 106651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski startEventDispatchThreadIfNecessary(); 106751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 106851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 106951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void removeNodeChangeListener(NodeChangeListener ncl) { 107051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 107151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 107251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed."); 107351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 1074e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath if (!nodeListeners.contains(ncl)) { 107551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalArgumentException("Listener not registered."); 1076e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath } 1077e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath 1078e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath nodeListeners.remove(ncl); 107951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 108051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 108151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 108251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // "SPI" METHODS 108351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 108451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 108551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Put the given key-value association into this preference node. It is 108651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * guaranteed that <tt>key</tt> and <tt>value</tt> are non-null and of 108751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * legal length. Also, it is guaranteed that this node has not been 108851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed. (The implementor needn't check for any of these things.) 108951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 109051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 1091bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * @param key the key 1092bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * @param value the value 109351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 109451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract void putSpi(String key, String value); 109551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 109651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 109751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Return the value associated with the specified key at this preference 109851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node, or <tt>null</tt> if there is no association for this key, or the 109951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * association cannot be determined at this time. It is guaranteed that 110051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>key</tt> is non-null. Also, it is guaranteed that this node has 110151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not been removed. (The implementor needn't check for either of these 110251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * things.) 110351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 110451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> Generally speaking, this method should not throw an exception 110551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * under any circumstances. If, however, if it does throw an exception, 110651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the exception will be intercepted and treated as a <tt>null</tt> 110751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * return value. 110851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 110951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 111051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 1111bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * @param key the key 111251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the value associated with the specified key at this preference 111351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node, or <tt>null</tt> if there is no association for this 111451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * key, or the association cannot be determined at this time. 111551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 111651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract String getSpi(String key); 111751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 111851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 111951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Remove the association (if any) for the specified key at this 112051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node. It is guaranteed that <tt>key</tt> is non-null. 112151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Also, it is guaranteed that this node has not been removed. 112251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (The implementor needn't check for either of these things.) 112351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 112451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 1125bc1e8f94811dd4cb821fa35bce1fd007a6c71a61Przemyslaw Szczepaniak * @param key the key 112651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 112751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract void removeSpi(String key); 112851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 112951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 113051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Removes this preference node, invalidating it and any preferences that 113151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it contains. The named child will have no descendants at the time this 113251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invocation is made (i.e., the {@link Preferences#removeNode()} method 113351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invokes this method repeatedly in a bottom-up fashion, removing each of 113451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * a node's descendants before removing the node itself). 113551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 113651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock held on this node and its 113751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * parent (and all ancestors that are being removed as a 113851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * result of a single invocation to {@link Preferences#removeNode()}). 113951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 114051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The removal of a node needn't become persistent until the 114151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <tt>flush</tt> method is invoked on this node (or an ancestor). 114251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 114351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this node throws a <tt>BackingStoreException</tt>, the exception 114451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will propagate out beyond the enclosing {@link #removeNode()} 114551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invocation. 114651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 114751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 114851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 114951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 115051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 115151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract void removeNodeSpi() throws BackingStoreException; 115251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 115351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 115451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns all of the keys that have an associated value in this 115551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node. (The returned array will be of size zero if 115651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this node has no preferences.) It is guaranteed that this node has not 115751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been removed. 115851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 115951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 116051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 116151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this node throws a <tt>BackingStoreException</tt>, the exception 116251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will propagate out beyond the enclosing {@link #keys()} invocation. 116351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 116451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return an array of the keys that have an associated value in this 116551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node. 116651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 116751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 116851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 116951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 117051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract String[] keysSpi() throws BackingStoreException; 117151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 117251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 117351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the names of the children of this preference node. (The 117451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * returned array will be of size zero if this node has no children.) 117551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method need not return the names of any nodes already cached, 117651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * but may do so without harm. 117751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 117851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 117951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 118051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this node throws a <tt>BackingStoreException</tt>, the exception 118151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will propagate out beyond the enclosing {@link #childrenNames()} 118251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invocation. 118351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 118451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return an array containing the names of the children of this 118551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node. 118651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 118751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 118851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 118951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 119051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract String[] childrenNamesSpi() 119151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws BackingStoreException; 119251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 119351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 119451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the named child if it exists, or <tt>null</tt> if it does not. 119551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * It is guaranteed that <tt>nodeName</tt> is non-null, non-empty, 119651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * does not contain the slash character ('/'), and is no longer than 119751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #MAX_NAME_LENGTH} characters. Also, it is guaranteed 119851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * that this node has not been removed. (The implementor needn't check 119951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * for any of these things if he chooses to override this method.) 120051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 120151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Finally, it is guaranteed that the named node has not been returned 120251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by a previous invocation of this method or {@link #childSpi} after the 120351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * last time that it was removed. In other words, a cached value will 120451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * always be used in preference to invoking this method. (The implementor 120551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * needn't maintain his own cache of previously returned children if he 120651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * chooses to override this method.) 120751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 120851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation obtains this preference node's lock, invokes 120951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link #childrenNames()} to get an array of the names of this node's 121051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * children, and iterates over the array comparing the name of each child 121151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with the specified node name. If a child node has the correct name, 121251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the {@link #childSpi(String)} method is invoked and the resulting 121351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node is returned. If the iteration completes without finding the 121451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * specified name, <tt>null</tt> is returned. 121551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 121651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param nodeName name of the child to be searched for. 121751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return the named child if it exists, or null if it does not. 121851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 121951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 122051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 122151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 122251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected AbstractPreferences getChild(String nodeName) 122351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws BackingStoreException { 122451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 122551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // assert kidCache.get(nodeName)==null; 122651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski String[] kidNames = childrenNames(); 122751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<kidNames.length; i++) 122851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (kidNames[i].equals(nodeName)) 122951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return childSpi(kidNames[i]); 123051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 123151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return null; 123251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 123351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 123451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 123551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the named child of this preference node, creating it if it does 123651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * not already exist. It is guaranteed that <tt>name</tt> is non-null, 123751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * non-empty, does not contain the slash character ('/'), and is no longer 123851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * than {@link #MAX_NAME_LENGTH} characters. Also, it is guaranteed that 123951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this node has not been removed. (The implementor needn't check for any 124051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of these things.) 124151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 124251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>Finally, it is guaranteed that the named node has not been returned 124351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * by a previous invocation of this method or {@link #getChild(String)} 124451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * after the last time that it was removed. In other words, a cached 124551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * value will always be used in preference to invoking this method. 124651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Subclasses need not maintain their own cache of previously returned 124751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * children. 124851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 124951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>The implementer must ensure that the returned node has not been 125051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed. If a like-named child of this node was previously removed, the 125151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * implementer must return a newly constructed <tt>AbstractPreferences</tt> 125251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node; once removed, an <tt>AbstractPreferences</tt> node 125351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * cannot be "resuscitated." 125451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 125551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this method causes a node to be created, this node is not 125651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * guaranteed to be persistent until the <tt>flush</tt> method is 125751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invoked on this node or one of its ancestors (or descendants). 125851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 125951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This method is invoked with the lock on this node held. 126051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 126151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param name The name of the child node to return, relative to 126251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this preference node. 126351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return The named child node. 126451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 126551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract AbstractPreferences childSpi(String name); 126651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 126751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 126851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns the absolute path name of this preferences node. 126951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 127051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public String toString() { 127151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return (this.isUserNode() ? "User" : "System") + 127251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski " Preference Node: " + this.absolutePath(); 127351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 127451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 127551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 127651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>sync</tt> method as per the specification in 127751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#sync()}. 127851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 127951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation calls a recursive helper method that locks this 128051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node, invokes syncSpi() on it, unlocks this node, and recursively 128151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invokes this method on each "cached child." A cached child is a child 128251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this node that has been created in this VM and not subsequently 128351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed. In effect, this method does a depth first traversal of the 128451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "cached subtree" rooted at this node, calling syncSpi() on each node in 128551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the subTree while only that node is locked. Note that syncSpi() is 128651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invoked top-down. 128751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 128851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 128951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 129051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 129151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IllegalStateException if this node (or an ancestor) has been 129251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 129351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #flush() 129451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 129551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void sync() throws BackingStoreException { 129651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski sync2(); 129751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 129851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 129951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void sync2() throws BackingStoreException { 130051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski AbstractPreferences[] cachedKids; 130151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 130251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 130351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (removed) 130451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throw new IllegalStateException("Node has been removed"); 130551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski syncSpi(); 130651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cachedKids = cachedChildren(); 130751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 130851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 130951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<cachedKids.length; i++) 131051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cachedKids[i].sync2(); 131151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 131251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 131351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 131451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method is invoked with this node locked. The contract of this 131551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is to synchronize any cached preferences stored at this node 131651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * with any stored in the backing store. (It is perfectly possible that 131751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this node does not exist on the backing store, either because it has 131851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * been deleted by another VM, or because it has not yet been created.) 131951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Note that this method should <i>not</i> synchronize the preferences in 132051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * any subnodes of this node. If the backing store naturally syncs an 132151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * entire subtree at once, the implementer is encouraged to override 132251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * sync(), rather than merely overriding this method. 132351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 132451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this node throws a <tt>BackingStoreException</tt>, the exception 132551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will propagate out beyond the enclosing {@link #sync()} invocation. 132651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 132751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 132851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 132951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 133051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 133151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract void syncSpi() throws BackingStoreException; 133251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 133351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 133451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>flush</tt> method as per the specification in 133551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#flush()}. 133651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 133751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>This implementation calls a recursive helper method that locks this 133851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * node, invokes flushSpi() on it, unlocks this node, and recursively 133951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invokes this method on each "cached child." A cached child is a child 134051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * of this node that has been created in this VM and not subsequently 134151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed. In effect, this method does a depth first traversal of the 134251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * "cached subtree" rooted at this node, calling flushSpi() on each node in 134351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the subTree while only that node is locked. Note that flushSpi() is 134451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * invoked top-down. 134551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 134651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p> If this method is invoked on a node that has been removed with 134751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the {@link #removeNode()} method, flushSpi() is invoked on this node, 134851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * but not on others. 134951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 135051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 135151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 135251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 135351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @see #flush() 135451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 135551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void flush() throws BackingStoreException { 135651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski flush2(); 135751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 135851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 135951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void flush2() throws BackingStoreException { 136051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski AbstractPreferences[] cachedKids; 136151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 136251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 136351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski flushSpi(); 136451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if(removed) 136551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return; 136651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cachedKids = cachedChildren(); 136751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 136851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 136951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i = 0; i < cachedKids.length; i++) 137051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski cachedKids[i].flush2(); 137151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 137251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 137351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 137451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method is invoked with this node locked. The contract of this 137551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method is to force any cached changes in the contents of this 137651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference node to the backing store, guaranteeing their persistence. 137751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * (It is perfectly possible that this node does not exist on the backing 137851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * store, either because it has been deleted by another VM, or because it 137951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * has not yet been created.) Note that this method should <i>not</i> 138051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * flush the preferences in any subnodes of this node. If the backing 138151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * store naturally flushes an entire subtree at once, the implementer is 138251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * encouraged to override flush(), rather than merely overriding this 138351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * method. 138451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 138551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * <p>If this node throws a <tt>BackingStoreException</tt>, the exception 138651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * will propagate out beyond the enclosing {@link #flush()} invocation. 138751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 138851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if this operation cannot be completed 138951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * due to a failure in the backing store, or inability to 139051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * communicate with it. 139151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 139251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected abstract void flushSpi() throws BackingStoreException; 139351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 139451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 139551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Returns <tt>true</tt> iff this node (or an ancestor) has been 139651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. This method 139751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locks this node prior to returning the contents of the private 139851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * field used to track this state. 139951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 140051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @return <tt>true</tt> iff this node (or an ancestor) has been 140151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * removed with the {@link #removeNode()} method. 140251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 140351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski protected boolean isRemoved() { 140451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 140551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return removed; 140651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 140751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 140851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 140951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 141051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Queue of pending notification events. When a preference or node 141151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * change event for which there are one or more listeners occurs, 141251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * it is placed on this queue and the queue is notified. A background 141351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * thread waits on this queue and delivers the events. This decouples 141451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * event delivery from preference activity, greatly simplifying 141551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * locking and reducing opportunity for deadlock. 141651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 141751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final List<EventObject> eventQueue = new LinkedList<>(); 141851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 141951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 142051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * These two classes are used to distinguish NodeChangeEvents on 142151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * eventQueue so the event dispatch thread knows whether to call 142251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * childAdded or childRemoved. 142351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 142451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private class NodeAddedEvent extends NodeChangeEvent { 142551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final long serialVersionUID = -6743557530157328528L; 142651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski NodeAddedEvent(Preferences parent, Preferences child) { 142751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(parent, child); 142851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 142951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 143051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private class NodeRemovedEvent extends NodeChangeEvent { 143151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static final long serialVersionUID = 8735497392918824837L; 143251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski NodeRemovedEvent(Preferences parent, Preferences child) { 143351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski super(parent, child); 143451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 143551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 143651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 143751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 143851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * A single background thread ("the event notification thread") monitors 143951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * the event queue and delivers events that are placed on the queue. 144051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 144151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static class EventDispatchThread extends Thread { 144251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void run() { 144351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while(true) { 144451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Wait on eventQueue till an event is present 144551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski EventObject event = null; 144651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(eventQueue) { 144751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski try { 144851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski while (eventQueue.isEmpty()) 144951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.wait(); 145051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski event = eventQueue.remove(0); 145151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } catch (InterruptedException e) { 145251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // XXX Log "Event dispatch thread interrupted. Exiting" 145351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski return; 145451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 145551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 145651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 145751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // Now we have event & hold no locks; deliver evt to listeners 145851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski AbstractPreferences src=(AbstractPreferences)event.getSource(); 145951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (event instanceof PreferenceChangeEvent) { 146051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski PreferenceChangeEvent pce = (PreferenceChangeEvent)event; 146151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski PreferenceChangeListener[] listeners = src.prefListeners(); 146251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<listeners.length; i++) 146351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski listeners[i].preferenceChange(pce); 146451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 146551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski NodeChangeEvent nce = (NodeChangeEvent)event; 146651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski NodeChangeListener[] listeners = src.nodeListeners(); 146751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (nce instanceof NodeAddedEvent) { 146851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<listeners.length; i++) 146951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski listeners[i].childAdded(nce); 147051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } else { 147151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // assert nce instanceof NodeRemovedEvent; 147251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski for (int i=0; i<listeners.length; i++) 147351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski listeners[i].childRemoved(nce); 147451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 147951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 148051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static Thread eventDispatchThread = null; 148151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 148251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 148351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * This method starts the event dispatch thread the first time it 148451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * is called. The event dispatch thread will be started only 148551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * if someone registers a listener. 148651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 148751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private static synchronized void startEventDispatchThreadIfNecessary() { 148851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski if (eventDispatchThread == null) { 148951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski // XXX Log "Starting event dispatch thread" 149051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventDispatchThread = new EventDispatchThread(); 149151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventDispatchThread.setDaemon(true); 149251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventDispatchThread.start(); 149351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 149451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 149551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 149651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 1497e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath * Return this node's preference/node change listeners. All accesses to prefListeners 1498e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath * and nodeListeners are guarded by |lock|. We return a copy of the list so that the 1499e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath * EventQueue thread will iterate over a fixed snapshot of the listeners at the time of 1500e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath * this call. 150151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 150251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski PreferenceChangeListener[] prefListeners() { 150351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 1504e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath return prefListeners.toArray(new PreferenceChangeListener[prefListeners.size()]); 150551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 150651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 150751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski NodeChangeListener[] nodeListeners() { 150851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(lock) { 1509e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath return nodeListeners.toArray(new NodeChangeListener[nodeListeners.size()]); 151051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 151151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 151251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 151351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 151451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Enqueue a preference change event for delivery to registered 151551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * preference change listeners unless there are no registered 151651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * listeners. Invoked with this.lock held. 151751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 151851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void enqueuePreferenceChangeEvent(String key, String newValue) { 1519e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath if (!prefListeners.isEmpty()) { 152051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(eventQueue) { 152151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.add(new PreferenceChangeEvent(this, key, newValue)); 152251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.notify(); 152351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 152451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 152551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 152651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 152751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 152851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Enqueue a "node added" event for delivery to registered node change 152951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * listeners unless there are no registered listeners. Invoked with 153051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this.lock held. 153151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 153251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void enqueueNodeAddedEvent(Preferences child) { 1533e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath if (!nodeListeners.isEmpty()) { 153451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(eventQueue) { 153551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.add(new NodeAddedEvent(this, child)); 153651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.notify(); 153751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 153851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 153951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 154051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 154151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 154251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Enqueue a "node removed" event for delivery to registered node change 154351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * listeners unless there are no registered listeners. Invoked with 154451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * this.lock held. 154551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 154651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski private void enqueueNodeRemovedEvent(Preferences child) { 1547e4297a336474b427ffc1044d822c9114dd8f58fdNarayan Kamath if (!nodeListeners.isEmpty()) { 154851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski synchronized(eventQueue) { 154951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.add(new NodeRemovedEvent(this, child)); 155051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski eventQueue.notify(); 155151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 155251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 155351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 155451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 155551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 155651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>exportNode</tt> method as per the specification in 155751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#exportNode(OutputStream)}. 155851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 155951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param os the output stream on which to emit the XML document. 156051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IOException if writing to the specified output stream 156151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * results in an <tt>IOException</tt>. 156251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if preference data cannot be read from 156351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * backing store. 156451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 156551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void exportNode(OutputStream os) 156651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws IOException, BackingStoreException 156751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 156851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski XmlSupport.export(os, this, false); 156951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 157051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski 157151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski /** 157251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * Implements the <tt>exportSubtree</tt> method as per the specification in 157351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * {@link Preferences#exportSubtree(OutputStream)}. 157451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * 157551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @param os the output stream on which to emit the XML document. 157651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws IOException if writing to the specified output stream 157751b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * results in an <tt>IOException</tt>. 157851b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * @throws BackingStoreException if preference data cannot be read from 157951b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski * backing store. 158051b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski */ 158151b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski public void exportSubtree(OutputStream os) 158251b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski throws IOException, BackingStoreException 158351b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski { 158451b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski XmlSupport.export(os, this, true); 158551b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski } 158651b1b6997fd3f980076b8081f7f1165ccc2a4008Piotr Jastrzebski} 1587