package.html revision bc47398187c6ffd132435e51d8d61e6ec79a79db
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<!--
3Licensed to the Apache Software Foundation (ASF) under one or more
4contributor license agreements.  See the NOTICE file distributed with
5this work for additional information regarding copyright ownership.
6The ASF licenses this file to You under the Apache License, Version 2.0
7(the "License"); you may not use this file except in compliance with
8the License.  You may obtain a copy of the License at
9
10     http://www.apache.org/licenses/LICENSE-2.0
11
12Unless required by applicable law or agreed to in writing, software
13distributed under the License is distributed on an "AS IS" BASIS,
14WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15See the License for the specific language governing permissions and
16limitations under the License.
17-->
18<html>
19<body bgcolor="white">
20<p>
21This package defines utility classes for working with streams, readers,
22writers and files. The most commonly used classes are described here:
23</p>
24<p>
25<b>IOUtils</b> is the most frequently used class.
26It provides operations to read, write, copy and close streams.
27</p>
28<p>
29<b>FileUtils</b> provides operations based around the JDK File class.
30These include reading, writing, copying, comparing and deleting.
31</p>
32<p>
33<b>FilenameUtils</b> provides utilities based on filenames.
34This utility class manipulates filenames without using File objects.
35It aims to simplify the transition between Windows and Unix.
36Before using this class however, you should consider whether you should
37be using File objects.
38</p>
39<p>
40<b>FileSystemUtils</b> allows access to the filing system in ways the JDK
41does not support. At present this allows you to get the free space on a drive.
42</p>
43<p>
44<b>EndianUtils</b> swaps data between Big-Endian and Little-Endian formats.
45</p>
46</body>
47</html>
48