is a lightweight yet powerful file management solution designed to simplify digital asset organization, access control, and rapid retrieval. Built with responsiveness and user efficiency in mind, it caters to individual professionals, small teams, and enterprises looking for a no‑bloat alternative to traditional file managers.
| Method | Return | Description | |--------|--------|-------------| | static NippyFile of(Path p) | NippyFile | Factory – validates non‑null and normalises the path. | | byte[] readAllBytes() | byte[] | Reads entire file into a byte array (uses FileChannel + ByteBuffer ). | | String readAllText() | String | Reads whole file as UTF‑8 string (or readAllText(Charset) ). | | List<String> readLines() | List<String> | Reads all lines, trimming line‑terminators. | | NippyFile writeAllBytes(byte[] data) | NippyFile | Overwrites file with the supplied bytes (creates parent dirs). | | NippyFile writeAllText(String text) | NippyFile | Writes UTF‑8 text (or custom charset). | | NippyFile writeLines(Collection<String> lines) | NippyFile | Writes each element as a separate line ( \n ). | | NippyFile copyTo(Path target, boolean overwrite) | NippyFile | Zero‑copy copy using FileChannel.transferTo . | | NippyFile moveTo(Path target, boolean overwrite) | NippyFile | Atomic move (fallback to copy+delete). | | InputStream asInputStream() | InputStream | Buffered stream; closes on close() . | | OutputStream asOutputStream() | OutputStream | Buffered stream; closes on close() . | | NippyFile zipTo(Path zipFile) | NippyFile | Packs the file into a ZIP (single‑entry). | | NippyFile unzipTo(Path dir) | NippyFile | Extracts a ZIP (must be a ZIP file). | | Path tempFile(String prefix, String suffix) | Path | Creates a temporary file that auto‑deletes on JVM exit. | | long size() | long | File size in bytes (throws if not existent). | | boolean exists() | boolean | Shortcut for Files.exists . | | NippyFile ensureParentExists() | NippyFile | Creates missing parent directories (no‑op if already present). | | CompletableFuture<byte[]> readAllBytesAsync() | CompletableFuture<byte[]> | Non‑blocking read using java.nio.file.AsynchronousFileChannel . | | CompletableFuture<NippyFile> writeAllBytesAsync(byte[] data) | CompletableFuture<NippyFile> | Non‑blocking write. | | NippyFile readOnly() / writeOnly() | NippyFile | Locks the wrapper to a specific mode (throws on illegal ops). | nippyfile j
Understanding Nippyfile: A Comprehensive Guide to Modern File Sharing is a lightweight yet powerful file management solution
All resources are closed automatically – no try‑with‑resources needed. | | byte[] readAllBytes() | byte[] | Reads
<dependency> <groupId>com.yourorg</groupId> <artifactId>nippyfile-j</artifactId> <version>1.3.0</version> </dependency>
Feel free to paste it straight into README.md of your GitHub repository, adjust the badges, URLs, and version numbers as needed, and you’ll have a polished front‑page for the project.
| Feature | NippyFile J | Traditional File Managers | |---------|-------------|---------------------------| | Instant search | ✅ Native index | ❌ Often OS‑dependent | | Cross‑platform sync | ✅ Delta sync | ⚠️ Full‑file only | | Granular RBAC | ✅ Folder/file level | ⚠️ Folder level only | | Embedded automation | ✅ Rule engine | ❌ Requires scripts | | Zero‑knowledge option | ✅ Yes | ⚠️ Rare |