Download everything from the project homepage at SourceForge. SourceForge


Pellucid

===========================================================================
Pellucid: JAVA library for transparent access to files and ZIP/JAR archives
===========================================================================

Project Info:  http://pellucid.sourceforge.net/
Project Lead:  Stefan Diener (stefan.diener@comvipro.de)

(C) Copyright 2004-2005, by COMVIPRO and Contributors.

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or (at
your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.

---------------
1. Introduction
---------------
"pellucid" is a JAVA library for transparent access to files and ZIP/JAR
archives. All archives will be handles as directories, so it is easy to
browse into them.

Pellucid provides a convenient way of integration into existing JAVA
applications. The main idea is to drill the File class by adding the ability
of transparently handling archives to it. Doing so all the existing code
using File objects may stay the same, but now you are able to browse through
archives just as they were regular directories on the file system. From the
programmer's point of view there's no longer a difference between the regular
file system and the contents of ZIP/JAR archives.

Limitations of the current version:
- archives inside an archive are handled as regular files, i.e. "pellucid"
  does not provide archive recursion yet
- write operations to entries inside an archive are not supported yet

These limitations may be resolved in a future version.

"pellucid" is licensed under the terms of the GNU Lesser General
Public Licence (LGPL). A copy of the licence is included in the
download.

Please note that "pellucid" is distributed WITHOUT ANY WARRANTY;
without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. Please refer to the licence for details.

Special thanks go to Prof. Karin Lunde for the inspiration to start this
project.

-----------------
2. Latest Version
-----------------
The latest version of this library can be obtained from:

    http://pellucid.sourceforge.net/

If you have an comments, suggestions or bugs to report, please post a
message in the project forum.

---------------
3. Dependencies
---------------

(a) JDK 1.4 or later. Download the latest version from
    http://java.sun.com/j2se/

(b) JUnit - a unit testing framework. JUnit is only required if you
    want to run the included tests. All tests have been created using
    JUnit 3.8.1. Download JUnit from
    http://www.junit.org/

-------------------
4. Ant Build Script
-------------------

An Ant build script (build.xml) is included in the distribution. This
is the same script that is used to create the "pellucid" distribution.
You may download Ant from http://ant.apache.org/

List of useful Ant targets:

compile
  Compile all production code classes not up to date (without debug
  information).

debug
  Like "compile" but with debug information.

test
  Compile and perform all tests.

docs
  Creates the HTML documentation for the complete production and test code.

jars
  Generates JARs for deployment.

clean
  Delete all class files (production and test code) and HTML documentation.

-------------
5. What's New
-------------
A list of changes in recent versions:

1.1 : (20-Jun-2005)
    - totally revised source code
    - PellucidArcFile: implemented toURI() and toURL() correctly
    - bugfixes

1.0 : (11-Jan-2005)
    - initial version