Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression.formats.tar

Class TapeArchiveEntryHeader.Builder

java.lang.Object

xyz.apollosoftware.bibliothiki.compression.formats.tar.TapeArchiveEntryHeader.Builder

Enclosing class:

TapeArchiveEntryHeader

public static final class TapeArchiveEntryHeader.Builder
extends Object

The builder for TapeArchiveEntryHeader.

Method Summary

Modifier and Type	Method	Description
@NonNull TapeArchiveEntryHeader	build()	Build the TapeArchiveEntryHeader.
@NonNull TapeArchiveEntryHeader.Builder	checksum(long checksum)	Set the checksum of the entry.
@NonNull TapeArchiveEntryHeader.Builder	fileSize(long fileSize)	Set the fileSize of the entry.
@NonNull TapeArchiveEntryHeader.Builder	group(long group)	Set the group of the entry.
@NonNull TapeArchiveEntryHeader.Builder	lastModified(Instant lastModified)	Set the last modification timestamp of the entry.
@NonNull TapeArchiveEntryHeader.Builder	linkedFile(String linkedFile)	Set the linked file of the entry (relevant only to types where TapeArchiveEntryHeader.Type.isLink() is true).
@NonNull TapeArchiveEntryHeader.Builder	mode(long mode)	Set the mode of the entry.
@NonNull TapeArchiveEntryHeader.Builder	name(@NonNull String name)	Set the name of the entry.
@NonNull TapeArchiveEntryHeader.Builder	owner(long owner)	Set the owner of the entry.
@NonNull TapeArchiveEntryHeader.Builder	type(TapeArchiveEntryHeader.Type type)	Set the TapeArchiveEntryHeader.Type of the entry.
@NonNull TapeArchiveEntryHeader.Builder	unixStandardHeader(TapeArchiveEntryHeader.UnixStandardEntryHeader unixStandardHeader)	Set the (UStar) UNIX Standard header information 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 TapeArchiveEntryHeader.Builder name(@NonNull String name)

Set the name of the entry.

Parameters:

name - The name of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

mode

public @NonNull TapeArchiveEntryHeader.Builder mode(long mode)

Set the mode of the entry.

Parameters:

mode - The mode of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

owner

public @NonNull TapeArchiveEntryHeader.Builder owner(long owner)

Set the owner of the entry.

Parameters:

owner - The owner of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

group

public @NonNull TapeArchiveEntryHeader.Builder group(long group)

Set the group of the entry.

Parameters:

group - The group of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

fileSize

public @NonNull TapeArchiveEntryHeader.Builder fileSize(long fileSize)

Set the fileSize of the entry.

Parameters:

fileSize - The fileSize of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

lastModified

public @NonNull TapeArchiveEntryHeader.Builder lastModified(Instant lastModified)

Set the last modification timestamp of the entry.

Parameters:

lastModified - The last modification timestamp of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

checksum

public @NonNull TapeArchiveEntryHeader.Builder checksum(long checksum)

Set the checksum of the entry.

Parameters:

checksum - The checksum of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

type

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

Set the TapeArchiveEntryHeader.Type of the entry.

Parameters:

type - The type of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

linkedFile

public @NonNull TapeArchiveEntryHeader.Builder linkedFile(String linkedFile)

Set the linked file of the entry (relevant only to types where TapeArchiveEntryHeader.Type.isLink() is true).

Parameters:

linkedFile - The linked file of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

unixStandardHeader

public @NonNull TapeArchiveEntryHeader.Builder unixStandardHeader(TapeArchiveEntryHeader.UnixStandardEntryHeader unixStandardHeader)

Set the (UStar) UNIX Standard header information of the entry.

Parameters:

unixStandardHeader - The UNIX Standard header information of the entry.

Returns:

The same TapeArchiveEntryHeader.Builder.

build

public @NonNull TapeArchiveEntryHeader build()

Build the TapeArchiveEntryHeader.

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

Returns:

The built TapeArchiveEntryHeader.