You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by ba...@apache.org on 2004/05/14 04:25:46 UTC
cvs commit: jakarta-commons/io/xdocs description.xml index.xml navigation.xml
bayard 2004/05/13 19:25:46
Modified: io/xdocs index.xml navigation.xml
Added: io/xdocs description.xml
Log:
index moved to description and a new index created. navigation updated to hook it in
Revision Changes Path
1.9 +67 -142 jakarta-commons/io/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/io/xdocs/index.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- index.xml 24 Apr 2004 23:53:01 -0000 1.8
+++ index.xml 14 May 2004 02:25:45 -0000 1.9
@@ -1,150 +1,75 @@
<?xml version="1.0"?>
-
<!--
- Main index
- $Id$
+Copyright 2002-2004 The Apache Software Foundation.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific iouage governing permissions and
+limitations under the License.
-->
<document>
- <properties>
- <title>Commons IO</title>
- <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
- </properties>
- <body>
-
- <section name="Commons IO">
- <p>
- Commons-IO contains <a href="#Utility classes">utility classes</a>,
- stream implementations, <a href="#File filters">file filters</a>, and
- <a href="#Endian classes">endian classes</a>.
- </p>
-
- <p>
- For a more detailed descriptions, take a look at the
- <a href="apidocs/index.html">JavaDocs</a>.
- </p>
- </section>
-
- <section name="Utility classes">
- <subsection name="CopyUtils and IOUtils">
- <p>
- <code>org.apache.commons.io.CopyUtils</code>
- contains a comprehensive set of static methods for copying
- from String, byte[], InputStream, Reader
- to OutputStream, Writer.
- </p>
- <p>
- <code>org.apache.commons.io.IOUtils</code>
- contains additional IO-related tools for safely closing streams
- and creating Strings and byte arrays from streams and Readers.
- </p>
-
- <p>
- As an example, consider the task of reading bytes
- from a URL, and printing them. This would typically done like this:
- </p>
-
- <source>
- InputStream in = new URL( "http://jakarta.apache.org" ).openStream();
- try {
- InputStreamReader inR = new InputStreamReader( in );
- BufferedReader buf = new BufferedReader( inR );
- String line;
- while ( ( line = buf.readLine() ) != null ) {
- System.out.println( line );
- }
- } finally {
- in.close();
- }
- </source>
-
- <p>
- With the IOUtils class, that could be done with:
- </p>
-
- <source>
- InputStream in = new URL( "http://jakarta.apache.org" ).openStream();
- try {
- System.out.println( IOUtils.toString( in ) );
- } finally {
- IOUtils.closeQuietly(in);
- }
- </source>
-
- <p>
- In certain application domains, such IO operations are
- common, and this class can save a great deal of time. And you can
- rely on well-tested code.
-
- For utility code such as this, flexibility and speed are of primary importance.
- </p>
-
- </subsection>
-
- <subsection name="FileUtils">
- <p>
- The <code>org.apache.commons.io.FileUtils</code>
- class contains methods for retrieving different components of a file path
- (directory name, file base name, file extension), methods
- for copying files to other files and directories, and methods
- for querying, deleting and cleaning directories. For more information,
- see the class description.
- </p>
- </subsection>
-
- </section>
-
- <section name="File filters">
- <p>
- The <code>org.apache.commons.io.filefilter</code>
- package defines an interface (<code>IOFileFilter</code>) that
- combines both <code>java.io.FileFilter</code> and
- <code>java.io.FilenameFilter</code>. Besides
- that the package offers a series of ready-to-use
- implementations of the <code>IOFileFilter</code>
- interface including
- implementation that allow you to combine other such filters.
-
- These filter can be used to list files or in FileDialog, for example.
- </p>
- </section>
-
- <section name="Endian classes">
- <p>
- Different computer architectures adopt different
- conventions for byte ordering. In so-called
- "Little Endian" architectures (eg Intel), the low-order
- byte is stored in memory at the lowest address, and
- subsequent bytes at higher addresses. For "Big Endian"
- architectures (eg Motorola), the situation is reversed.
- </p>
-
- <p>
- There are two classes in this package of relevance:
- </p>
-
- <ul>
- <li>
- The <code>org.apache.commons.io.EndianUtils</code>
- class contains static methods for swapping the Endian-ness
- of Java primitives and streams.
- </li>
-
- <li>
- The <code>org.apache.commons.io.input.SwappedDataInputStream</code>
- class is an implementation of the <code>DataInput</code> interface. With
- this, one can read data from files of non-native Endian-ness.
- </li>
- </ul>
-
- <p>
- For more information, see
- <a
- href="http://www.cs.umass.edu/~verts/cs32/endian.html">http://www.cs.umass.edu/~verts/cs32/endian.html</a>
- </p>
-
- </section>
- </body>
+ <properties>
+ <title>Commons IO</title>
+ <author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
+ </properties>
+
+ <body>
+
+<section name="Commons IO">
+
+<p>
+</p>
+</section>
+
+<section name="Latest Release">
+<p>The latest release of Apache Jakarta Commons IO is version 1.0. It is available (from mirrors) in <a href="http://jakarta.apache.org/site/binindex.cgi#commons-io">binary</a> and <a href="http://jakarta.apache.org/site/sourceindex.cgi#commons-io">source</a> downloads. </p>
+</section>
+
+<section name="Documentation">
+<p>
+A top level description of some of the classes to be found in the IO component is available - <a href="description.html">Description</a>.
+</p>
+
+<p>
+The <a href="http://jakarta.apache.org/commons/io/apidocs/index.html">JavaDoc API documents</a> are available online.
+</p>
+</section>
+
+<section name="Bugs">
+<p>
+Bugs may be reported via the Bugzilla Management system. The following links may prove useful:
+</p>
+<ul>
+ <li><a href="http://issues.apache.org/bugzilla/createaccount.cgi">Create a Bugzilla account</a></li>
+ <li><a href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Commons">Submit a bug report</a></li>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=RESOLVED&bug_status=VERIFIED&bug_status=CLOSED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All IO bugs</a></li>
+ <li><a href="http://issues.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Commons&component=IO&short_desc=&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&cmdtype=doit&newqueryname=&order=Reuse+same+sort+as+last+time">All open IO bugs</a></li>
+</ul>
+</section>
+
+<section name="Releases">
+<ul>
+<li><a href="http://jakarta.apache.org/site/binindex.cgi#commons-io">Version 1.0</a></li>
+</ul>
+</section>
+
+<section name="Repository">
+<ul>
+<li>
+<a href="http://cvs.apache.org/viewcvs/jakarta-commons/io/">CVS Repository</a>
+</li>
+</ul>
+</section>
+</body>
</document>
+
1.11 +1 -0 jakarta-commons/io/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/jakarta-commons/io/xdocs/navigation.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- navigation.xml 2 Mar 2004 03:27:48 -0000 1.10
+++ navigation.xml 14 May 2004 02:25:45 -0000 1.11
@@ -11,6 +11,7 @@
<menu name="Commons IO">
<item name="Overview" href="index.html"/>
+ <item name="Description" href="description.html"/>
<item name="Javadoc" href="apidocs/index.html"/>
<item name="Best practices" href="bestpractices.html"/>
<item name="Building" href="building.html"/>
1.1 jakarta-commons/io/xdocs/description.xml
Index: description.xml
===================================================================
<?xml version="1.0"?>
<!--
Main index
$Id: description.xml,v 1.1 2004/05/14 02:25:45 bayard Exp $
-->
<document>
<properties>
<title>About Commons IO</title>
<author email="commons-dev@jakarta.apache.org">Commons Documentation Team</author>
</properties>
<body>
<section name="Commons IO">
<p>
Commons-IO contains <a href="#Utility classes">utility classes</a>,
stream implementations, <a href="#File filters">file filters</a>, and
<a href="#Endian classes">endian classes</a>.
</p>
<p>
For a more detailed descriptions, take a look at the
<a href="apidocs/index.html">JavaDocs</a>.
</p>
</section>
<section name="Utility classes">
<subsection name="CopyUtils and IOUtils">
<p>
<code>org.apache.commons.io.CopyUtils</code>
contains a comprehensive set of static methods for copying
from String, byte[], InputStream, Reader
to OutputStream, Writer.
</p>
<p>
<code>org.apache.commons.io.IOUtils</code>
contains additional IO-related tools for safely closing streams
and creating Strings and byte arrays from streams and Readers.
</p>
<p>
As an example, consider the task of reading bytes
from a URL, and printing them. This would typically done like this:
</p>
<source>
InputStream in = new URL( "http://jakarta.apache.org" ).openStream();
try {
InputStreamReader inR = new InputStreamReader( in );
BufferedReader buf = new BufferedReader( inR );
String line;
while ( ( line = buf.readLine() ) != null ) {
System.out.println( line );
}
} finally {
in.close();
}
</source>
<p>
With the IOUtils class, that could be done with:
</p>
<source>
InputStream in = new URL( "http://jakarta.apache.org" ).openStream();
try {
System.out.println( IOUtils.toString( in ) );
} finally {
IOUtils.closeQuietly(in);
}
</source>
<p>
In certain application domains, such IO operations are
common, and this class can save a great deal of time. And you can
rely on well-tested code.
For utility code such as this, flexibility and speed are of primary importance.
</p>
</subsection>
<subsection name="FileUtils">
<p>
The <code>org.apache.commons.io.FileUtils</code>
class contains methods for retrieving different components of a file path
(directory name, file base name, file extension), methods
for copying files to other files and directories, and methods
for querying, deleting and cleaning directories. For more information,
see the class description.
</p>
</subsection>
</section>
<section name="File filters">
<p>
The <code>org.apache.commons.io.filefilter</code>
package defines an interface (<code>IOFileFilter</code>) that
combines both <code>java.io.FileFilter</code> and
<code>java.io.FilenameFilter</code>. Besides
that the package offers a series of ready-to-use
implementations of the <code>IOFileFilter</code>
interface including
implementation that allow you to combine other such filters.
These filter can be used to list files or in FileDialog, for example.
</p>
</section>
<section name="Endian classes">
<p>
Different computer architectures adopt different
conventions for byte ordering. In so-called
"Little Endian" architectures (eg Intel), the low-order
byte is stored in memory at the lowest address, and
subsequent bytes at higher addresses. For "Big Endian"
architectures (eg Motorola), the situation is reversed.
</p>
<p>
There are two classes in this package of relevance:
</p>
<ul>
<li>
The <code>org.apache.commons.io.EndianUtils</code>
class contains static methods for swapping the Endian-ness
of Java primitives and streams.
</li>
<li>
The <code>org.apache.commons.io.input.SwappedDataInputStream</code>
class is an implementation of the <code>DataInput</code> interface. With
this, one can read data from files of non-native Endian-ness.
</li>
</ul>
<p>
For more information, see
<a
href="http://www.cs.umass.edu/~verts/cs32/endian.html">http://www.cs.umass.edu/~verts/cs32/endian.html</a>
</p>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org