source: josm/trunk/src/org/tukaani/xz/package-info.java@ 15998

Last change on this file since 15998 was 13350, checked in by stoecker, 7 years ago

see #15816 - add XZ support

File size: 1.4 KB
Line 
1/*
2 * package-info
3 *
4 * Author: Lasse Collin <lasse.collin@tukaani.org>
5 *
6 * This file has been put into the public domain.
7 * You can do whatever you want with this file.
8 */
9
10/**
11 * XZ data compression support.
12 *
13 * <h4>Introduction</h4>
14 * <p>
15 * This aims to be a complete implementation of XZ data compression
16 * in pure Java. Features:
17 * <ul>
18 * <li>Full support for the .xz file format specification version 1.0.4</li>
19 * <li>Single-threaded streamed compression and decompression</li>
20 * <li>Single-threaded decompression with limited random access support</li>
21 * <li>Raw streams (no .xz headers) for advanced users, including LZMA2
22 * with preset dictionary</li>
23 * </ul>
24 * <p>
25 * Threading is planned but it is unknown when it will be implemented.
26 * <p>
27 * For the latest source code, see the
28 * <a href="http://tukaani.org/xz/java.html">home page of XZ for Java</a>.
29 *
30 * <h4>Getting started</h4>
31 * <p>
32 * Start by reading the documentation of {@link org.tukaani.xz.XZOutputStream}
33 * and {@link org.tukaani.xz.XZInputStream}.
34 * If you use XZ inside another file format or protocol,
35 * see also {@link org.tukaani.xz.SingleXZInputStream}.
36 *
37 * <h4>Licensing</h4>
38 * <p>
39 * XZ for Java has been put into the public domain, thus you can do
40 * whatever you want with it. All the files in the package have been
41 * written by Lasse Collin and/or Igor Pavlov.
42 * <p>
43 * This software is provided "as is", without any warranty.
44 */
45package org.tukaani.xz;
Note: See TracBrowser for help on using the repository browser.