properties.html

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

store</H3>
<PRE>
public void <B>store</B>(java.io.OutputStream&nbsp;out,
                  <A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;comments)
           throws java.io.IOException</PRE>
<DL>
<DD>以适合使用 <A HREF="Properties.html#load(java.io.InputStream)"><CODE>load</CODE></A> 方法加载到 <code>Properties</code> 表中的格式，将此 <code>Properties</code> 表中的属性列表（键和元素对）写入输出流。使用 ISO 8859-1 字符编码写入该流。
 <p>
对于来自此 <code>Properties</code> 表默认表（如果有的话）的属性，此方法<i>不</i> 将其写入 out。
 <p>
如果 comments 变量非 null，则首先将 ASCII <code>#</code> 字符、注释字符串和一个行分隔符写入输出流。因此，该 <code>comments</code> 可用作一个标识注释。
 <p>
接下来总是写入一个注释行，该行包括一个 ASCII <code>#</code> 字符、当前的日期和时间（就好像使用 <code>Date</code> 的 <code>toString</code> 方法获取当前时间一样）和一个由 Writer 生成的行分隔符。
 <p>
然后将此 <code>Properties</code> 表中的所有项写入 out，一次一行。对于每个项而言，先写入键字符串，然后是一个 ASCII <code>=</code>，最后是关联元素字符串。检查键和元素字符串的每个字符，确定是否应将其呈现为转义序列。ASCII 字符 <code>\</code>、制表符、换页符、换行符和回车分别作为 <code>\\</code>、<code>\t</code>、<code>\f</code>、<code>\n</code> 和 <code>\r</code> 写入。小于 <code>\u0020</code> 和大于 <code>\u007E</code> 的字符作为 <code>\u</code><i>xxxx</i> 写入，其中 <i>xxxx</i> 是该字符相应的十六进制值。对于键，所有写入的空白字符前面都有一个 <code>\</code> 字符。对于元素，所有写入的前导空白字符（但是不嵌入或尾随空白字符）前面都有一个 <code>\</code> 字符。所有写入的键和元素字符 <code>#</code>、<code>!</code>、<code>=</code> 和 <code>:</code> 前面都有反斜杠，确保能正确地加载这些字符。
 <p>
写入各个项后，刷新输出流。此方法返回后，输出流仍保持打开状态。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>out</CODE> - 输出流。<DD><CODE>comments</CODE> - 属性列表的描述。
<DT><B>抛出：</B>
<DD><CODE>java.io.IOException</CODE> - 如果将此属性列表写入指定的输出流时，抛出 <tt>IOException</tt>。
<DD><CODE><A HREF="../lang/ClassCastException.html" title="java.lang 中的类">ClassCastException</A></CODE> - 如果此 <code>Properties</code> 对象包含任意非 <code>Strings</code> 的键或值。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <code>out</code> 为 null。<DT><B>从以下版本开始：</B></DT>
  <DD>1.2</DD>
</DL>
</DD>
</DL>
<HR>

<A NAME="loadFromXML(java.io.InputStream)"><!-- --></A><H3>
loadFromXML</H3>
<PRE>
public void <B>loadFromXML</B>(java.io.InputStream&nbsp;in)
                 throws java.io.IOException,
                        <A HREF="InvalidPropertiesFormatException.html" title="java.util 中的类">InvalidPropertiesFormatException</A></PRE>
<DL>
<DD>将指定输入流中由 XML 文档所表示的所有属性加载到此属性表中。

<p>该 XML 文档必须具有以下 DOCTYPE 声明：
 <pre>
 &lt;!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"&gt;
 </pre>
而且该文档还必须满足上述属性 DTD 的要求。

<p>此方法返回后，指定的流仍保持打开状态。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>in</CODE> - 从中读取 XML 文档的输入流。
<DT><B>抛出：</B>
<DD><CODE>java.io.IOException</CODE> - 如果读取指定的输入流导致 <tt>IOException</tt>。
<DD><CODE><A HREF="InvalidPropertiesFormatException.html" title="java.util 中的类">InvalidPropertiesFormatException</A></CODE> - 输入流中的数据没有按要求的文档类型组成有效的 XML 文档。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <code>in</code> 为 null。<DT><B>从以下版本开始：</B></DT>
  <DD>1.5</DD>
<DT><B>另请参见：</B><DD><A HREF="Properties.html#storeToXML(java.io.OutputStream, java.lang.String, java.lang.String)"><CODE>storeToXML(OutputStream, String, String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="storeToXML(java.io.OutputStream, java.lang.String)"><!-- --></A><H3>
storeToXML</H3>
<PRE>
public void <B>storeToXML</B>(java.io.OutputStream&nbsp;os,
                       <A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;comment)
                throws java.io.IOException</PRE>
<DL>
<DD>发出一个表示此表中包含的所有属性的 XML 文档。

<p> 以 <tt>props.storeToXML(os, comment)</tt> 的形式调用此方法的行为与调用 <tt>props.storeToXML(os, comment, "UTF-8");</tt> 完全相同。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>os</CODE> - 根据其内容发出 XML 文档的输出流。<DD><CODE>comment</CODE> - 属性列表的描述，或者如果没有所需的注释，则为 <code>null</code>。
<DT><B>抛出：</B>
<DD><CODE>java.io.IOException</CODE> - 如果写入指定的输出流导致一个 <tt>IOException</tt>。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <code>os</code> 为 null。<DT><B>从以下版本开始：</B></DT>
  <DD>1.5</DD>
<DT><B>另请参见：</B><DD><A HREF="Properties.html#loadFromXML(java.io.InputStream)"><CODE>loadFromXML(InputStream)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="storeToXML(java.io.OutputStream, java.lang.String, java.lang.String)"><!-- --></A><H3>
storeToXML</H3>
<PRE>
public void <B>storeToXML</B>(java.io.OutputStream&nbsp;os,
                       <A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;comment,
                       <A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;encoding)
                throws java.io.IOException</PRE>
<DL>
<DD>使用指定的编码发出一个表示此表中包含的所有属性的 XML 文档。

<p>该 XML 文档要具有以下 DOCTYPE 声明：
 <pre>
 &lt;!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"&gt;
 </pre>

<p>如果指定的注释为 <code>null</code>，则没有注释存储在该文档中。

<p>此方法返回后，指定的流仍保持打开状态。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>os</CODE> - 根据其内容发出 XML 文档的输出流。<DD><CODE>comment</CODE> - 属性列表的描述，或者如果没有所需的注释，则为 <code>null</code>。
<DT><B>抛出：</B>
<DD><CODE>java.io.IOException</CODE> - 如果写入指定的输出流导致一个 <tt>IOException</tt>。
<DD><CODE><A HREF="../lang/NullPointerException.html" title="java.lang 中的类">NullPointerException</A></CODE> - 如果 <code>os</code> 为 <code>null</code>，或者如果 <code>encoding</code> 为 <code>null</code>。<DT><B>从以下版本开始：</B></DT>
  <DD>1.5</DD>
<DT><B>另请参见：</B><DD><A HREF="Properties.html#loadFromXML(java.io.InputStream)"><CODE>loadFromXML(InputStream)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public <A HREF="../lang/String.html" title="java.lang 中的类">String</A> <B>getProperty</B>(<A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;key)</PRE>
<DL>
<DD>用指定的键在此属性列表中搜索属性。如果在此属性列表中未找到该键，则接着递归检查默认属性列表及其默认值。如果未找到属性，则此方法返回 <code>null</code>。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>key</CODE> - 属性键。
<DT><B>返回：</B><DD>属性列表中具有指定键值的值。<DT><B>另请参见：</B><DD><A HREF="Properties.html#setProperty(java.lang.String, java.lang.String)"><CODE>setProperty(java.lang.String, java.lang.String)</CODE></A>, 
<A HREF="Properties.html#defaults"><CODE>defaults</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getProperty(java.lang.String, java.lang.String)"><!-- --></A><H3>
getProperty</H3>
<PRE>
public <A HREF="../lang/String.html" title="java.lang 中的类">String</A> <B>getProperty</B>(<A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;key,
                          <A HREF="../lang/String.html" title="java.lang 中的类">String</A>&nbsp;defaultValue)</PRE>
<DL>
<DD>用指定的键在属性列表中搜索属性。如果在属性列表中未找到该键，则接着递归检查默认属性列表及其默认值。如果未找到属性，则此方法返回默认值变量。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>key</CODE> - 哈希表键。<DD><CODE>defaultValue</CODE> - 默认值。
<DT><B>返回：</B><DD>属性列表中具有指定键值的值。<DT><B>另请参见：</B><DD><A HREF="Properties.html#setProperty(java.lang.String, java.lang.String)"><CODE>setProperty(java.lang.String, java.lang.String)</CODE></A>, 
<A HREF="Properties.html#defaults"><CODE>defaults</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="propertyNames()"><!-- --></A><H3>
propertyNames</H3>
<PRE>
public <A HREF="Enumeration.html" title="java.util 中的接口">Enumeration</A>&lt;?&gt; <B>propertyNames</B>()</PRE>
<DL>
<DD>返回属性列表中所有键的枚举，如果在主属性列表中未找到同名的键，则包括默认属性列表中不同的键。
<P>
<DD><DL>

<DT><B>返回：</B><DD>属性列表中所有键的枚举，包括默认属性列表中的键。<DT><B>另请参见：</B><DD><A HREF="Enumeration.html" title="java.util 中的接口"><CODE>Enumeration</CODE></A>, 
<A HREF="Properties.html#defaults"><CODE>defaults</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="list(java.io.PrintStream)"><!-- --></A><H3>
list</H3>
<PRE>
public void <B>list</B>(java.io.PrintStream&nbsp;out)</PRE>
<DL>
<DD>将属性列表输出到指定的输出流。此方法对调试很有用。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>out</CODE> - 输出流。</DL>
</DD>
</DL>
<HR>

<A NAME="list(java.io.PrintWriter)"><!-- --></A><H3>
list</H3>
<PRE>
public void <B>list</B>(java.io.PrintWriter&nbsp;out)</PRE>
<DL>
<DD>将属性列表输出到指定的输出流。此方法对调试很有用。
<P>
<DD><DL>
<DT><B>参数：</B><DD><CODE>out</CODE> - 输出流。<DT><B>从以下版本开始：</B></DT>
  <DD>JDK1.1</DD>
</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="跳过导航链接"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>概述</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>软件包</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>类</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/Properties.html"><FONT CLASS="NavBarFont1"><B>使用</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>树</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>已过时</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>索引</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../help-doc.html"><FONT CLASS="NavBarFont1"><B>帮助</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
<b>Java<sup><font size=-2>TM</font></sup>&nbsp;2&nbsp;Platform<br>Standard&nbsp;Ed. 5.0</b></EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="PriorityQueue.html" title="java.util 中的类"><B>上一个类</B></A>&nbsp;
&nbsp;<A HREF="PropertyPermission.html" title="java.util 中的类"><B>下一个类</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../index.html@java_2Futil_2FProperties.html" target="_top"><B>框架</B></A>  &nbsp;
&nbsp;<A HREF="Properties.html" target="_top"><B>无框架</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../allclasses-noframe.html"><B>所有类</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../allclasses-noframe.html"><B>所有类</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  摘要：&nbsp;嵌套&nbsp;|&nbsp;<A HREF="#field_summary">字段</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_summary">方法</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
详细信息：&nbsp;<A HREF="#field_detail">字段</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">构造方法</A>&nbsp;|&nbsp;<A HREF="#method_detail">方法</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<font size="-1"><a href="../../../../../../../../java.sun.com/cgi-bin/bugreport.cgi">提交错误或意见</a><br>有关更多的 API 参考资料和开发人员文档，请参阅 <a href="../../../../../../../../java.sun.com/j2se/1.5.0/docs/relnotes/devdocs-vs-specs.html">Java 2 SDK SE 开发人员文档</a>。该文档包含更详细的、面向开发人员的描述，以及总体概述、术语定义、使用技巧和工作代码示例。 <p>版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守<a href="../../../../../../../../java.sun.com/j2se/1.5.0/docs/relnotes/license.html">许可证条款</a>。另请参阅<a href="../../../../../../../../java.sun.com/docs/redist.html">文档重新分发政策</a>。</font>
</BODY>
</HTML>