This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-compress.git
commit 189b41792b28be4f0aa0bb09e8876ee911af20e6 Author: Gary Gregory <[email protected]> AuthorDate: Sat Mar 18 08:45:37 2023 -0400 Javadoc: Convert package.html to package-info.java --- .../compress/compressors/lz4/package-info.java | 32 +++++++++++++++++ .../commons/compress/compressors/lz4/package.html | 41 ---------------------- 2 files changed, 32 insertions(+), 41 deletions(-) diff --git a/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java b/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java new file mode 100644 index 00000000..95ec3510 --- /dev/null +++ b/src/main/java/org/apache/commons/compress/compressors/lz4/package-info.java @@ -0,0 +1,32 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 language governing permissions and limitations + * under the License. + */ + +/** + * Provides stream classes for the <a href="http://lz4.github.io/lz4/">LZ4</a> algorithm. + * <p> + * The block LZ4 format which only contains the compressed data is supported by the <code>BlockLZ4Compressor*putStream</code> classes while the frame format is + * implemented by <code>FramedLZ4Compressor*putStream</code>. The implementation in Commons Compress is based on the specifications "Last revised: 2015-03-26" + * for the block format and version "1.5.1 (31/03/2015)" for the frame format. + * </p> + * <p> + * Only the frame format can be auto-detected this means you have to speficy the format explicitly if you want to read a block LZ4 stream via + * <code>CompressorStreamFactory</code>. + * </p> + */ +package org.apache.commons.compress.compressors.lz4; \ No newline at end of file diff --git a/src/main/java/org/apache/commons/compress/compressors/lz4/package.html b/src/main/java/org/apache/commons/compress/compressors/lz4/package.html deleted file mode 100644 index 0c8d7b76..00000000 --- a/src/main/java/org/apache/commons/compress/compressors/lz4/package.html +++ /dev/null @@ -1,41 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> -<!-- - - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You 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 language governing permissions and - limitations under the License. - ---> - <head> - <title>lz4 package</title> - </head> - <body> - <p>Provides stream classes for the - <a href="http://lz4.github.io/lz4/">LZ4</a> - algorithm.</p> - - <p>The block LZ4 format which only contains the compressed data is - supported by the <code>BlockLZ4Compressor*putStream</code> - classes while the frame format is implemented - by <code>FramedLZ4Compressor*putStream</code>. The - implementation in Commons Compress is based on the - specifications "Last revised: 2015-03-26" for the block format - and version "1.5.1 (31/03/2015)" for the frame format.</p> - - <p>Only the frame format can be auto-detected this means you have - to speficy the format explicitly if you want to read a block LZ4 - stream via <code>CompressorStreamFactory</code>.</p> - </body> -</html>
