Lines Matching refs:node
46 * A node in a hierarchical collection of preference data. This class
65 * directories in a hierarchical file system. Every node in a preference
66 * tree has a <i>node name</i> (which is not necessarily unique),
70 * <p>The root node has a node name of the empty string (""). Every other
71 * node has an arbitrary node name, specified at the time it is created. The
75 * <p>The root node has an absolute path name of <tt>"/"</tt>. Children of
76 * the root node have absolute path names of <tt>"/" + </tt><i><node
78 * absolute path name></i><tt> + "/" + </tt><i><node name></i>.
81 * <p>A node <i>n</i>'s path name relative to its ancestor <i>a</i>
87 * <li>Every node's path name relative to itself is the empty string.
88 * <li>Every node's path name relative to its parent is its node name (except
89 * for the root node, which does not have a parent).
90 * <li>Every node's path name relative to the root is its absolute path name
157 * (if any), and one node for each child of the root (if any). -->
158 * <!ELEMENT root (map, node*) >
165 * <!-- Each node has a map representing its preferences (if any),
166 * and one node for each child (if any). -->
167 * <!ELEMENT node (map, node*) >
169 * <!-- Additionally, each node has a name attribute -->
170 * <!ATTLIST node
173 * <!-- A map represents the preferences stored at a node (if any). -->
326 * Maximum length of a node name (80 characters).
331 * Returns the preference node from the calling user's preference tree
333 * The convention is as follows: the absolute path name of the node is the
336 * absolute path name of the node associated with the class
340 * associated preference node is <tt><unnamed></tt>. This node
344 * at this node as it is shared by all programs that use it.</i>
347 * package can obtain a preference node as follows: <pre>
351 * preferences node and decreases the likelihood of a run-time failure.
356 * node and its ancestors if they do not already exist. If the returned
357 * node did not exist prior to this call, this node and any ancestors that
359 * the <tt>flush</tt> method is called on the returned node (or one of its
362 * @param c the class for whose package a user preference node is desired.
363 * @return the user preference node associated with the package of which
371 return userRoot().node(nodeName(c));
375 * Returns the preference node from the system preference tree that is
377 * convention is as follows: the absolute path name of the node is the
380 * absolute path name of the node associated with the class
384 * associated preference node is <tt><unnamed></tt>. This node
388 * at this node as it is shared by all programs that use it.</i>
391 * package can obtain a preference node as follows: <pre>
395 * preferences node and decreases the likelihood of a run-time failure.
400 * node and its ancestors if they do not already exist. If the returned
401 * node did not exist prior to this call, this node and any ancestors that
403 * the <tt>flush</tt> method is called on the returned node (or one of its
406 * @param c the class for whose package a system preference node is desired.
407 * @return the system preference node associated with the package of which
415 return systemRoot().node(nodeName(c));
419 * Returns the absolute path name of the node corresponding to the package
422 * @throws IllegalArgumentException if the package has node preferences
423 * node associated with it.
428 "Arrays have no associated preferences node.");
445 * Returns the root preference node for the calling user.
447 * @return the root preference node for the calling user.
461 * Returns the root preference node for the system.
463 * @return the root preference node for the system.
485 * preference node.
493 * @throws IllegalStateException if this node (or an ancestor) has been
500 * node. Returns the specified default if there is no value associated
510 * preference node has no value associated with <tt>key</tt>.
514 * @throws IllegalStateException if this node (or an ancestor) has been
523 * node, if any.
530 * @param key key whose mapping is to be removed from the preference node.
532 * @throws IllegalStateException if this node (or an ancestor) has been
539 * preference node. This call has no effect on any descendants
540 * of this node.
543 * node in the preferences hierarchy contains any such defaults,
550 * @throws IllegalStateException if this node (or an ancestor) has been
558 * specified key in this preference node. The associated string is the
568 * @throws IllegalStateException if this node (or an ancestor) has been
576 * specified key in this preference node. The string is converted to
591 * preference node has no value associated with <tt>key</tt>
595 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
598 * @throws IllegalStateException if this node (or an ancestor) has been
608 * specified key in this preference node. The associated string is the
618 * @throws IllegalStateException if this node (or an ancestor) has been
626 * specified key in this preference node. The string is converted to
641 * preference node has no value associated with <tt>key</tt>
645 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
648 * @throws IllegalStateException if this node (or an ancestor) has been
658 * specified key in this preference node. The associated string is
668 * @throws IllegalStateException if this node (or an ancestor) has been
677 * specified key in this preference node. Valid strings
696 * preference node has no value associated with <tt>key</tt>
700 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
703 * @throws IllegalStateException if this node (or an ancestor) has been
713 * specified key in this preference node. The associated string is the
723 * @throws IllegalStateException if this node (or an ancestor) has been
731 * specified key in this preference node. The string is converted to an
745 * preference node has no value associated with <tt>key</tt>
749 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
752 * @throws IllegalStateException if this node (or an ancestor) has been
762 * specified key in this preference node. The associated string is the
772 * @throws IllegalStateException if this node (or an ancestor) has been
780 * specified key in this preference node. The string is converted to an
794 * preference node has no value associated with <tt>key</tt>
798 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
801 * @throws IllegalStateException if this node (or an ancestor) has been
811 * specified key in this preference node. The associated string is
827 * @throws IllegalStateException if this node (or an ancestor) has been
836 * the specified key in this preference node. Valid strings are
857 * preference node has no value associated with <tt>key</tt>
861 * <tt>key</tt> in this preference node, or <tt>def</tt> if the
864 * @throws IllegalStateException if this node (or an ancestor) has been
875 * preference node. (The returned array will be of size zero if
876 * this node has no preferences.)
879 * are any such defaults at this node that have not been overridden,
884 * preference node.
888 * @throws IllegalStateException if this node (or an ancestor) has been
894 * Returns the names of the children of this preference node, relative to
895 * this node. (The returned array will be of size zero if this node has
898 * @return the names of the children of this preference node.
902 * @throws IllegalStateException if this node (or an ancestor) has been
908 * Returns the parent of this preference node, or <tt>null</tt> if this is
911 * @return the parent of this preference node.
912 * @throws IllegalStateException if this node (or an ancestor) has been
918 * Returns the named preference node in the same tree as this node,
922 * interpreted relative to this preference node.
924 * <p>If the returned node did not exist prior to this call, this node and
927 * the returned node (or one of its ancestors or descendants).
929 * @param pathName the path name of the preference node to return.
930 * @return the specified preference node.
935 * @throws IllegalStateException if this node (or an ancestor) has been
939 public abstract Preferences node(String pathName);
942 * Returns true if the named preference node exists in the same tree
943 * as this node. Relative path names (which do not begin with the slash
945 * node.
947 * <p>If this node (or an ancestor) has already been removed with the
953 * @param pathName the path name of the node whose existence
955 * @return true if the specified node exists.
963 * @throws IllegalStateException if this node (or an ancestor) has been
971 * Removes this preference node and all of its descendants, invalidating
972 * any preferences contained in the removed nodes. Once a node has been
975 * {@link #node(String) nodeExists("")} on the corresponding
978 * can still be invoked on a node after it has been removed; they will not
982 * <tt>flush</tt> method is called on this node (or an ancestor).
985 * node exposes any stored defaults at or below this node. Thus, a
986 * subsequent call to <tt>nodeExists</tt> on this node's path name may
987 * return <tt>true</tt>, and a subsequent call to <tt>node</tt> on this
994 * @throws IllegalStateException if this node (or an ancestor) has already
997 * the root node.
1003 * Returns this preference node's name, relative to its parent.
1005 * @return this preference node's name, relative to its parent.
1010 * Returns this preference node's absolute path name.
1012 * @return this preference node's absolute path name.
1017 * Returns <tt>true</tt> if this preference node is in the user
1020 * @return <tt>true</tt> if this preference node is in the user
1027 * Returns a string representation of this preferences node,
1034 * Forces any changes in the contents of this preference node and its
1037 * subtree rooted at this node prior to the method invocation have become
1043 * <p>When a flush occurs on a newly created node, it is made persistent,
1048 * <p> If this method is invoked on a node that has been removed with
1049 * the {@link #removeNode()} method, flushSpi() is invoked on this node,
1060 * Ensures that future reads from this preference node and its
1063 * side-effect, forces any changes in the contents of this preference node
1065 * method had been invoked on this node.
1070 * @throws IllegalStateException if this node (or an ancestor) has been
1078 * events</i> for this preference node. A preference change event is
1079 * generated when a preference is added to this node, removed from this
1080 * node, or when the value associated with a preference is changed.
1082 * #removeNode()} method, which generates a <i>node change event</i>.
1090 * when preferences are modified in descendants of this node; a caller
1095 * @throws IllegalStateException if this node (or an ancestor) has been
1109 * preference change listener on this node.
1110 * @throws IllegalStateException if this node (or an ancestor) has been
1118 * Registers the specified listener to receive <i>node change events</i>
1119 * for this node. A node change event is generated when a child node is
1120 * added to or removed from this node. (A single {@link #removeNode()}
1121 * invocation results in multiple <i>node change events</i>, one for every
1122 * node in the subtree rooted at the removed node.)
1128 * when indirect descendants of this node are added or removed; a
1131 * <p>Few guarantees can be made regarding node creation. Because nodes
1133 * implementation to determine whether a child node existed in the backing
1136 * circumstances, implementations are neither required to generate node
1141 * @throws IllegalStateException if this node (or an ancestor) has been
1154 * <tt>NodeChangeListener</tt> on this node.
1155 * @throws IllegalStateException if this node (or an ancestor) has been
1163 * of the preferences contained in this node (but not its descendants).
1164 * This XML document is, in effect, an offline backup of the node.
1175 * at this node are modified concurrently with an invocation of this
1177 * preferences contained in the node; some of the concurrent modifications
1186 * @throws IllegalStateException if this node (or an ancestor) has been
1194 * in this node and all of its descendants. This XML document is, in
1195 * effect, an offline backup of the subtree rooted at the node.
1206 * or nodes in the subtree rooted at this node are modified concurrently
1216 * @throws IllegalStateException if this node (or an ancestor) has been
1245 * notably {@link #node(String)} and {@link #put(String, String)}.