Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression

Class ArchiveEntry.Builder

java.lang.Object

xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.Builder

Enclosing class:

ArchiveEntry

public static final class ArchiveEntry.Builder
extends Object

The builder for ArchiveEntry.

Method Summary

Modifier and Type	Method	Description
@NonNull ArchiveEntry	build()	Build the ArchiveEntry.
@NonNull ArchiveEntry.Builder	name(@NonNull String name)	Set the name (qualified file path) of the entry.
@NonNull ArchiveEntry.Builder	permissions(@Nullable ArchiveEntry.PermissionSet permissions)	Set the UNIX permissions of the entry.
@NonNull ArchiveEntry.Builder	size(@Nullable Long size)	Set the file size, in bytes, of the entry.
@NonNull ArchiveEntry.Builder	type(@NonNull ArchiveEntry.Type type)	Set the ArchiveEntry.Type of the entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

name

public @NonNull ArchiveEntry.Builder name(@NonNull String name)

Set the name (qualified file path) of the entry.

Parameters:

name - The name of the entry.

Returns:

The same ArchiveEntry.Builder.

type

public @NonNull ArchiveEntry.Builder type(@NonNull ArchiveEntry.Type type)

Set the ArchiveEntry.Type of the entry.

Parameters:

type - The type of the entry.

Returns:

The same ArchiveEntry.Builder.

permissions

public @NonNull ArchiveEntry.Builder permissions(@Nullable ArchiveEntry.PermissionSet permissions)

Set the UNIX permissions of the entry.

Parameters:

permissions - The permissions of the entry.

Returns:

The same ArchiveEntry.Builder.

size

public @NonNull ArchiveEntry.Builder size(@Nullable Long size)

Set the file size, in bytes, of the entry.

Parameters:

size - The size of the entry.

Returns:

The same ArchiveEntry.Builder.

build

public @NonNull ArchiveEntry build()

Build the ArchiveEntry.

If any of the fields were invalid, they will fail at this point as this is when the ArchiveEntry constructor is executed.

Returns:

The built ArchiveEntry.