preferences.html

来自「j2se5-api-zh,java文档的中文版本」· HTML 代码 · 共 1,010 行 · 第 1/5 页

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>字段详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="MAX_KEY_LENGTH"><!-- --></A><H3>
MAX_KEY_LENGTH</H3>
<PRE>
public static final int <B>MAX_KEY_LENGTH</B></PRE>
<DL>
<DD>允许作为键的字符串最大长度（80 个字符）。
<P>
<DL>
<DT><B>另请参见：</B><DD><A HREF="../../../constant-values.html#java.util.prefs.Preferences.MAX_KEY_LENGTH">常量字段值</A></DL>
</DL>
<HR>

<A NAME="MAX_VALUE_LENGTH"><!-- --></A><H3>
MAX_VALUE_LENGTH</H3>
<PRE>
public static final int <B>MAX_VALUE_LENGTH</B></PRE>
<DL>
<DD>允许作为值的字符串最大长度（8192 个字符）。
<P>
<DL>
<DT><B>另请参见：</B><DD><A HREF="../../../constant-values.html#java.util.prefs.Preferences.MAX_VALUE_LENGTH">常量字段值</A></DL>
</DL>
<HR>

<A NAME="MAX_NAME_LENGTH"><!-- --></A><H3>
MAX_NAME_LENGTH</H3>
<PRE>
public static final int <B>MAX_NAME_LENGTH</B></PRE>
<DL>
<DD>节点名的最大长度（80 个字符）。
<P>
<DL>
<DT><B>另请参见：</B><DD><A HREF="../../../constant-values.html#java.util.prefs.Preferences.MAX_NAME_LENGTH">常量字段值</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>构造方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="Preferences()"><!-- --></A><H3>
Preferences</H3>
<PRE>
protected <B>Preferences</B>()</PRE>
<DL>
<DD>单独的构造方法。（由子类构造方法调用，通常是隐式的）。
<P>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>方法详细信息</B></FONT></TH>
</TR>
</TABLE>

<A NAME="userNodeForPackage(java.lang.Class)"><!-- --></A><H3>
userNodeForPackage</H3>
<PRE>
public static <A HREF="Preferences.html" title="java.util.prefs 中的类">Preferences</A> <B>userNodeForPackage</B>(<A HREF="../../lang/Class.html" title="java.lang 中的类">Class</A>&lt;?&gt;&nbsp;c)</PRE>
<DL>
<DD>从调用用户首选项树（根据约定，它与指定类的包相关联）返回首选项节点。约定如下：节点的绝对路径名就是完全限定的包名，开头使用一个斜杠 (<tt>'/'</tt>)，并将其中的每一个句点 (<tt>'.'</tt>) 都替换为斜杠。例如，与类 <tt>com.acme.widget</tt> 关联的节点绝对路径名是 <tt>/com/acme/widget</tt>。

<p>此约定不适用于未命名的包，未命名包的关联首选项节点是 <tt>&lt;unnamed&gt;</tt>。此节点只是为了方便程序的早期开发（而非长期使用）而存在的，它不属于任何包，只用于&ldquo;一次性&rdquo;程序。<i>在此节点中不应该存储有价值的数据，因为使用它的所有程序都可以共享它。</i>

<p>希望访问与其包有关的首选项类 <tt>Foo</tt> 可以获得以下首选项节点： <pre>
    static Preferences prefs = Preferences.userNodeForPackage(Foo.class);
 </pre>
此语句消除了使用字符串描述首选项节点的需求，从而降低了发生运行时故障的可能性。（如果类名称拼写错误，则通常会导致编译时错误。）

<p>调用此方法将导致返回节点及其祖先的创建（如果它们不存在）。如果在此调用之前返回的节点不存在，那么在对返回节点（或者其某个祖先或子节点）调用 <tt>flush</tt> 方法之前，不能保证由此调用所创建的节点及其所有祖先是永久性的。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</CODE> - 用户首选项节点需要其包的类。
<DT><B>返回：</B><DD>与 <tt>c</tt> 成员所属包相关联的用户首选项节点。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <tt>c</tt> 为 <tt>null</tt>。
<DD><CODE><A HREF="../../lang/SecurityException.html" title="java.lang 中的类">SecurityException</A></CODE> - 如果安全管理器存在并且拒绝 <tt>RuntimePermission(&quot;preferences&quot;)</tt>。<DT><B>另请参见：</B><DD><A HREF="../../lang/RuntimePermission.html" title="java.lang 中的类"><CODE>RuntimePermission</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="systemNodeForPackage(java.lang.Class)"><!-- --></A><H3>
systemNodeForPackage</H3>
<PRE>
public static <A HREF="Preferences.html" title="java.util.prefs 中的类">Preferences</A> <B>systemNodeForPackage</B>(<A HREF="../../lang/Class.html" title="java.lang 中的类">Class</A>&lt;?&gt;&nbsp;c)</PRE>
<DL>
<DD>从系统首选项树（根据约定，它与指定类的包相关联）返回首选项节点。约定如下：节点的绝对路径名就是完全限定的包名，开头使用一个斜杠 (<tt>'/'</tt>)，并将其中的每一个句点 (<tt>'.'</tt>) 都替换为斜杠。例如，与类 <tt>com.acme.widget</tt> 关联的节点绝对路径名是 <tt>/com/acme/widget</tt>。

<p>此约定不适用于未命名的包，未命名包的关联首选项节点是 <tt>&lt;unnamed&gt;</tt>。此节点只是为了方便程序的早期开发（而非长期使用）而存在的，它不属于任何包，只用于&ldquo;一次性&rdquo;程序。<i>在此节点中不应该存储有价值的数据，因为使用它的所有程序都可以共享它。</i>

<p>希望访问与其包有关的首选项类 <tt>Foo</tt> 可以获得以下首选项节点：<pre>
  static Preferences prefs = Preferences.systemNodeForPackage(Foo.class);
 </pre>
此语句消除了使用字符串描述首选项节点的需求，从而降低了发生运行时故障的可能性。（如果类名称拼写错误，则通常会导致编译时错误。）

<p>调用此方法将导致返回节点及其祖先的创建（如果它们不存在）。如果在此调用之前返回的节点不存在，那么在对返回节点（或者其某个祖先或子节点）调用 <tt>flush</tt> 方法之前，不能保证由此调用所创建的节点及其所有祖先是永久性的。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>c</CODE> - 系统首选项节点需要其包的类。
<DT><B>返回：</B><DD>与 <tt>c</tt> 成员所属包相关联的用户首选项节点。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <tt>c</tt> 为 <tt>null</tt>。
<DD><CODE><A HREF="../../lang/SecurityException.html" title="java.lang 中的类">SecurityException</A></CODE> - 如果安全管理器存在并且拒绝 <tt>RuntimePermission(&quot;preferences&quot;)</tt>。<DT><B>另请参见：</B><DD><A HREF="../../lang/RuntimePermission.html" title="java.lang 中的类"><CODE>RuntimePermission</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="userRoot()"><!-- --></A><H3>
userRoot</H3>
<PRE>
public static <A HREF="Preferences.html" title="java.util.prefs 中的类">Preferences</A> <B>userRoot</B>()</PRE>
<DL>
<DD>返回调用用户的根首选项节点。
<P>
<DD><DL>

<DT><B>返回：</B><DD>调用用户的根首选项节点。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/SecurityException.html" title="java.lang 中的类">SecurityException</A></CODE> - 如果安全管理器存在并且拒绝 <tt>RuntimePermission(&quot;preferences&quot;)</tt>。<DT><B>另请参见：</B><DD><A HREF="../../lang/RuntimePermission.html" title="java.lang 中的类"><CODE>RuntimePermission</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="systemRoot()"><!-- --></A><H3>
systemRoot</H3>
<PRE>
public static <A HREF="Preferences.html" title="java.util.prefs 中的类">Preferences</A> <B>systemRoot</B>()</PRE>
<DL>
<DD>返回系统的根首选项节点。
<P>
<DD><DL>

<DT><B>返回：</B><DD>系统的根首选项节点。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/SecurityException.html" title="java.lang 中的类">SecurityException</A></CODE> - 如果安全管理器存在并且拒绝 <tt>RuntimePermission(&quot;preferences&quot;)</tt>。<DT><B>另请参见：</B><DD><A HREF="../../lang/RuntimePermission.html" title="java.lang 中的类"><CODE>RuntimePermission</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="put(java.lang.String, java.lang.String)"><!-- --></A><H3>
put</H3>
<PRE>
public abstract void <B>put</B>(<A HREF="../../lang/String.html" title="java.lang 中的类">String</A>&nbsp;key,
                         <A HREF="../../lang/String.html" title="java.lang 中的类">String</A>&nbsp;value)</PRE>
<DL>
<DD>将指定值与此首选项节点中的指定键相关联。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>key</CODE> - 指定的 value 将要关联的键。<DD><CODE>value</CODE> - 指定的 key 将要关联的值。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 key 或 value 为 <tt>null</tt>。
<DD><CODE><A HREF="../../lang/IllegalArgumentException.html" title="java.lang 中的类">IllegalArgumentException</A></CODE> - 如果 <tt>key.length()</tt> 超过 <tt>MAX_KEY_LENGTH</tt> 或者如果 <tt>value.length</tt> 超过 <tt>MAX_VALUE_LENGTH</tt>。
<DD><CODE><A HREF="../../lang/IllegalStateException.html" title="java.lang 中的类">IllegalStateException</A></CODE> - 如果已经使用 <A HREF="Preferences.html#removeNode()"><CODE>removeNode()</CODE></A> 方法移除了此节点（或其祖先）。</DL>
</DD>
</DL>
<HR>

<A NAME="get(java.lang.String, java.lang.String)"><!-- --></A><H3>
get</H3>
<PRE>
public abstract <A HREF="../../lang/String.html" title="java.lang 中的类">String</A> <B>get</B>(<A HREF="../../lang/String.html" title="java.lang 中的类">String</A>&nbsp;key,
                           <A HREF="../../lang/String.html" title="java.lang 中的类">String</A>&nbsp;def)</PRE>
<DL>
<DD>返回与此首选项节点中指定键相关联的值。如果不存在与该键相关联的值或者内部存储不可访问，则返回指定的默认值。

<p>有些实现可能将默认值存储在其内部存储中。如果不存在与指定键相关联的值，而只有<i>存储的默认值</i>，则系统优先返回存储的默认值（而不是指定的默认值）。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>key</CODE> - 要返回其相关值的键。<DD><CODE>def</CODE> - 此首选项节点不具有与 <tt>key</tt> 相关联的值时所要返回的值。
<DT><B>返回：</B><DD>与 <tt>key</tt> 相关联的值；如果没有与 <tt>key</tt> 相关联的值或者内部存储不可用，则返回 <tt>def</tt>。
<DT><B>抛出：</B>
<DD><CODE><A HREF="../../lang/IllegalStateException.html" title="java.lang 中的类">IllegalStateException</A></CODE> - 如果已经使用 <A HREF="Preferences.html#removeNode()"><CODE>removeNode()</CODE></A> 方法移除了此节点（或其祖先）。
<DD><CODE><A HREF="../../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <tt>key</tt> 为 <tt>null</tt>。（值 <tt>null</tt> 用于 <tt>def</tt> <i>是</i> 允许的。）</DL>
</DD>
</DL>
<HR>

<A NAME="remove(java.lang.String)"><!-- --></A><H3>
remove</H3>
<PRE>
public abstract void <B>remove</B>(<A HREF="../../lang/String.html" title="java.lang 中的类">String</A>&nbsp;key)</PRE>
<DL>
<DD>移除与此首选项节点中与指定键相关联的值（如果有）。