Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shuoros/jcompressor
JCompressor is an easy-to-use library in Java that can be used to compress different files and folders by various methods such as Zip, Gzip, Stufflt, 7z etc., and extract files and folders from those different compressed files.
https://github.com/shuoros/jcompressor
7z compression compression-library file gzip java rar zip
Last synced: about 5 hours ago
JSON representation
JCompressor is an easy-to-use library in Java that can be used to compress different files and folders by various methods such as Zip, Gzip, Stufflt, 7z etc., and extract files and folders from those different compressed files.
- Host: GitHub
- URL: https://github.com/shuoros/jcompressor
- Owner: shuoros
- License: mit
- Created: 2022-01-03T18:19:20.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-29T08:51:28.000Z (almost 3 years ago)
- Last Synced: 2023-12-21T20:28:14.748Z (11 months ago)
- Topics: 7z, compression, compression-library, file, gzip, java, rar, zip
- Language: Java
- Homepage: https://shuoros.github.io/jcompressor
- Size: 319 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
JCompressor
Is a library for managing files in Java which easily and with the least line of code gives you
the ability to manage files like moving through folders and directories, reading files and folders information,
creating new files or folders, making changes to files and folders such as renaming or hiding them, deleting files
and folders, searching for files or folders by regex and compressing files and folders or extracting them from zip files.
If you like this project, help me by giving me a star =))<3
## What is in V0.1.0
- Compress a list of files in zip.
- Extract zip files.
## Hello JCompressor
To use JCompressor you just need to make a simple call to your desired API and JCompressor will do the rest.
For example:
```java
import io.github.shuoros.jcompressor.JCompressor;
import io.github.shuoros.jcompressor.compress.ZipCompressor;
import java.util.List;
public class Main {
public static void main(String[] args) {
// Create A ZipCompressor
JCompressor jCompressor = new ZipCompressor();
File file = new File("/home/soroush/Desktop/file.txt");
File zipFile = new File("/home/soroush/Desktop/file.zip");
// Compress file to a zip file
jCompressor.compress(List.of(file), zipFile);
File extractDestination = new File("/home/soroush/Desktop/extractHere/");
// Extract a zip file
jCompressor.extract(zipFile, extractDestination);
}
}
```
## Installation
You can use **JCompressor** with any project management tool:
### Maven
```xml
io.github.shuoros
JCompressor
0.1.0
```
### Gradle
```gradle
// https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
implementation group: 'io.github.shuoros', name: 'JCompressor', version: '0.1.0'
```
Or
```gradle
// https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
implementation 'io.github.shuoros:JCompressor:0.1.0'
```
And in **Kotlin**
```gradle
// https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
implementation("io.github.shuoros:JCompressor:0.1.0")
```
### SBT
```sbt
// https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
libraryDependencies += "io.github.shuoros" % "JCompressor" % "0.1.0"
```
### Ivy
```xml
```
### Grape
```java
// https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
@Grapes(
@Grab(group = 'io.github.shuoros', module = 'JCompressor', version = '0.1.0')
)
```
### Leiningen
```clj
;; https://mvnrepository.com/artifact/io.github.shuoros/JCompressor
[io.github.shuoros/JCompressor "0.1.0"]
```
## Authors
JCompressor is developed by [Soroush Shemshadi](https://github.com/shuoros)
and [contributors](https://github.com/shuoros/JCompressor/blob/main/CONTRIBUTORS.md).
## Contribution
If you want to contribute on this project, Please read
the [contribution guide](https://github.com/shuoros/JCompressor/blob/main/CONTRIBUTE.md).
## Releases
To see the changes in different versions of JCompressor, you can read
the [release notes](https://github.com/shuoros/JCompressor/blob/main/RELEASENOTES.md).
## Issues
If you encounter a bug or vulnerability, please read
the [issue policy](https://github.com/shuoros/JCompressor/blob/main/ISSUES.md).
## Documentation
To learn how to work with JCompressor, please take a look at the [/doc](https://github.com/shuoros/JCompressor/tree/main/doc)
folder.
## Acknowledgement
A great thanks to [@sarahrajabi](https://github.com/sarahrajabi) for designing the logo.