/www/tags/NOV_07_2009/htdocs/api/org/gjt/sp/util/IOUtilities.html
HTML | 395 lines | 342 code | 43 blank | 10 comment | 0 complexity | 8b7d750dcae45794401500f030094410 MD5 | raw file
Possible License(s): BSD-3-Clause, AGPL-1.0, Apache-2.0, LGPL-2.0, LGPL-3.0, GPL-2.0, CC-BY-SA-3.0, LGPL-2.1, GPL-3.0, MPL-2.0-no-copyleft-exception, IPL-1.0
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!--NewPage-->
- <HTML>
- <HEAD>
- <!-- Generated by javadoc (build 1.5.0_14) on Tue Jul 22 07:14:16 GMT-08:00 2008 -->
- <TITLE>
- IOUtilities (jEdit API)
- </TITLE>
- <META NAME="keywords" CONTENT="org.gjt.sp.util.IOUtilities class">
- <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
- <NOSCRIPT>
- </NOSCRIPT>
- </HEAD>
- <BODY BGCOLOR="white" >
- <!-- ========= START OF TOP NAVBAR ======= -->
- <A NAME="navbar_top"><!-- --></A>
- <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
- <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
- <TR>
- <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
- <A NAME="navbar_top_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>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IOUtilities.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/gjt/sp/util/IntegerArray.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/util/Log.html" title="class in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/gjt/sp/util/IOUtilities.html" target="_top"><B>FRAMES</B></A>
- <A HREF="IOUtilities.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_top"></A>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <HR>
- <!-- ======== START OF CLASS DATA ======== -->
- <H2>
- <FONT SIZE="-1">
- org.gjt.sp.util</FONT>
- <BR>
- Class IOUtilities</H2>
- <PRE>
- java.lang.Object
- <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.gjt.sp.util.IOUtilities</B>
- </PRE>
- <HR>
- <DL>
- <DT><PRE>public class <B>IOUtilities</B><DT>extends java.lang.Object</DL>
- </PRE>
- <P>
- IO tools that depends on JDK only.
- <P>
- <P>
- <DL>
- <DT><B>Since:</B></DT>
- <DD>4.3pre5</DD>
- </DL>
- <HR>
- <P>
- <!-- ========== METHOD SUMMARY =========== -->
- <A NAME="method_summary"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
- <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
- <B>Method Summary</B></FONT></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#closeQuietly(java.io.Closeable)">closeQuietly</A></B>(java.io.Closeable closeable)</CODE>
- <BR>
- Method that will close an <CODE>Closeable</CODE> ignoring it if it is null and ignoring exceptions.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#closeQuietly(java.io.InputStream)">closeQuietly</A></B>(java.io.InputStream in)</CODE>
- <BR>
- Method that will close an <CODE>InputStream</CODE> ignoring it if it is null and ignoring exceptions.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#closeQuietly(java.io.OutputStream)">closeQuietly</A></B>(java.io.OutputStream out)</CODE>
- <BR>
- Method that will close an <CODE>OutputStream</CODE> ignoring it if it is null and ignoring exceptions.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static void</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#closeQuietly(java.io.Reader)">closeQuietly</A></B>(java.io.Reader r)</CODE>
- <BR>
- Method that will close an <CODE>Reader</CODE> ignoring it if it is null and ignoring exceptions.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#copyStream(int, org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)">copyStream</A></B>(int bufferSize,
- <A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.io.InputStream in,
- java.io.OutputStream out,
- boolean canStop)</CODE>
- <BR>
- Copy an input stream to an output stream.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#copyStream(org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)">copyStream</A></B>(<A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.io.InputStream in,
- java.io.OutputStream out,
- boolean canStop)</CODE>
- <BR>
- Copy an input stream to an output stream with a buffer of 4096 bytes.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static long</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#fileLength(java.io.File)">fileLength</A></B>(java.io.File file)</CODE>
- <BR>
- Returns the length of a file.</TD>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
- <CODE>static boolean</CODE></FONT></TD>
- <TD><CODE><B><A HREF="../../../../org/gjt/sp/util/IOUtilities.html#moveFile(java.io.File, java.io.File)">moveFile</A></B>(java.io.File source,
- java.io.File dest)</CODE>
- <BR>
- Moves the source file to the destination.</TD>
- </TR>
- </TABLE>
- <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
- <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
- <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
- <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
- </TR>
- <TR BGCOLOR="white" CLASS="TableRowColor">
- <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
- </TR>
- </TABLE>
-
- <P>
- <!-- ============ 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>Method Detail</B></FONT></TH>
- </TR>
- </TABLE>
- <A NAME="moveFile(java.io.File, java.io.File)"><!-- --></A><H3>
- moveFile</H3>
- <PRE>
- public static boolean <B>moveFile</B>(java.io.File source,
- java.io.File dest)</PRE>
- <DL>
- <DD>Moves the source file to the destination.
- If the destination cannot be created or is a read-only file, the
- method returns <code>false</code>. Otherwise, the contents of the
- source are copied to the destination, the source is deleted,
- and <code>true</code> is returned.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>source</CODE> - The source file to move.<DD><CODE>dest</CODE> - The destination where to move the file.
- <DT><B>Returns:</B><DD>true on success, false otherwise.<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre9</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="copyStream(int, org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)"><!-- --></A><H3>
- copyStream</H3>
- <PRE>
- public static boolean <B>copyStream</B>(int bufferSize,
- <A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.io.InputStream in,
- java.io.OutputStream out,
- boolean canStop)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Copy an input stream to an output stream.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>bufferSize</CODE> - the size of the buffer<DD><CODE>progress</CODE> - the progress observer it could be null<DD><CODE>in</CODE> - the input stream<DD><CODE>out</CODE> - the output stream<DD><CODE>canStop</CODE> - if true, the copy can be stopped by interrupting the thread
- <DT><B>Returns:</B><DD><code>true</code> if the copy was done, <code>false</code> if it was interrupted
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - IOException If an I/O error occurs</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="copyStream(org.gjt.sp.util.ProgressObserver, java.io.InputStream, java.io.OutputStream, boolean)"><!-- --></A><H3>
- copyStream</H3>
- <PRE>
- public static boolean <B>copyStream</B>(<A HREF="../../../../org/gjt/sp/util/ProgressObserver.html" title="interface in org.gjt.sp.util">ProgressObserver</A> progress,
- java.io.InputStream in,
- java.io.OutputStream out,
- boolean canStop)
- throws java.io.IOException</PRE>
- <DL>
- <DD>Copy an input stream to an output stream with a buffer of 4096 bytes.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>progress</CODE> - the progress observer it could be null<DD><CODE>in</CODE> - the input stream<DD><CODE>out</CODE> - the output stream<DD><CODE>canStop</CODE> - if true, the copy can be stopped by interrupting the thread
- <DT><B>Returns:</B><DD><code>true</code> if the copy was done, <code>false</code> if it was interrupted
- <DT><B>Throws:</B>
- <DD><CODE>java.io.IOException</CODE> - IOException If an I/O error occurs</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="fileLength(java.io.File)"><!-- --></A><H3>
- fileLength</H3>
- <PRE>
- public static long <B>fileLength</B>(java.io.File file)</PRE>
- <DL>
- <DD>Returns the length of a file. If it is a directory it will calculate recursively the length.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>file</CODE> - the file or directory
- <DT><B>Returns:</B><DD>the length of the file or directory. If the file doesn't exists it will return 0<DT><B>Since:</B></DT>
- <DD>4.3pre10</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="closeQuietly(java.io.InputStream)"><!-- --></A><H3>
- closeQuietly</H3>
- <PRE>
- public static void <B>closeQuietly</B>(java.io.InputStream in)</PRE>
- <DL>
- <DD>Method that will close an <CODE>InputStream</CODE> ignoring it if it is null and ignoring exceptions.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>in</CODE> - the InputStream to close.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="closeQuietly(java.io.OutputStream)"><!-- --></A><H3>
- closeQuietly</H3>
- <PRE>
- public static void <B>closeQuietly</B>(java.io.OutputStream out)</PRE>
- <DL>
- <DD>Method that will close an <CODE>OutputStream</CODE> ignoring it if it is null and ignoring exceptions.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>out</CODE> - the OutputStream to close.</DL>
- </DD>
- </DL>
- <HR>
- <A NAME="closeQuietly(java.io.Reader)"><!-- --></A><H3>
- closeQuietly</H3>
- <PRE>
- public static void <B>closeQuietly</B>(java.io.Reader r)</PRE>
- <DL>
- <DD>Method that will close an <CODE>Reader</CODE> ignoring it if it is null and ignoring exceptions.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>r</CODE> - the Reader to close.<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre5</DD>
- </DL>
- </DD>
- </DL>
- <HR>
- <A NAME="closeQuietly(java.io.Closeable)"><!-- --></A><H3>
- closeQuietly</H3>
- <PRE>
- public static void <B>closeQuietly</B>(java.io.Closeable closeable)</PRE>
- <DL>
- <DD>Method that will close an <CODE>Closeable</CODE> ignoring it if it is null and ignoring exceptions.
- <P>
- <DD><DL>
- <DT><B>Parameters:</B><DD><CODE>closeable</CODE> - the closeable to close.<DT><B>Since:</B></DT>
- <DD>jEdit 4.3pre8</DD>
- </DL>
- </DD>
- </DL>
- <!-- ========= END OF CLASS DATA ========= -->
- <HR>
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <A NAME="navbar_bottom"><!-- --></A>
- <A HREF="#skip-navbar_bottom" title="Skip navigation links"></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>Overview</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
- <TD BGCOLOR="#00008B" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/IOUtilities.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
- <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
- </TR>
- </TABLE>
- </TD>
- <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
- </EM>
- </TD>
- </TR>
- <TR>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../org/gjt/sp/util/IntegerArray.html" title="class in org.gjt.sp.util"><B>PREV CLASS</B></A>
- <A HREF="../../../../org/gjt/sp/util/Log.html" title="class in org.gjt.sp.util"><B>NEXT CLASS</B></A></FONT></TD>
- <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
- <A HREF="../../../../index.html?org/gjt/sp/util/IOUtilities.html" target="_top"><B>FRAMES</B></A>
- <A HREF="IOUtilities.html" target="_top"><B>NO FRAMES</B></A>
-
- <NOSCRIPT>
- <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
- </NOSCRIPT>
- </FONT></TD>
- </TR>
- <TR>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
- <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
- DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
- </TR>
- </TABLE>
- <A NAME="skip-navbar_bottom"></A>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- <HR>
- </BODY>
- </HTML>