Module xyz.apollosoftware.bibliothiki.compression

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

Class TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder

java.lang.Object

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

Enclosing class:

TapeArchiveEntryHeader.UnixStandardEntryHeader

public static final class TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder
extends Object

The builder for TapeArchiveEntryHeader.UnixStandardEntryHeader.

Method Summary

Modifier and Type	Method	Description
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader	build()	Build the TapeArchiveEntryHeader.UnixStandardEntryHeader.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	deviceMajorNumber(long deviceMajorNumber)	Set the device major version number of the entry.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	deviceMinorNumber(long deviceMinorNumber)	Set the device minor version number of the entry.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	filenamePrefix(String filenamePrefix)	Set the filename prefix of the entry.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	groupName(String groupName)	Set the owner group name of the entry.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	userName(String userName)	Set the owner username of the entry.
@NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder	version(short version)	Set the version of the entry.

Methods inherited from class java.lang.Object

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

Method Details

version

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder version(short version)

Set the version of the entry.

Parameters:

version - The version of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

userName

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder userName(String userName)

Set the owner username of the entry.

Parameters:

userName - The username of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

groupName

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder groupName(String groupName)

Set the owner group name of the entry.

Parameters:

groupName - The group name of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

deviceMajorNumber

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder deviceMajorNumber(long deviceMajorNumber)

Set the device major version number of the entry. (This is relevant only to types where TapeArchiveEntryHeader.Type.isDevice() is true).

Parameters:

deviceMajorNumber - The device major version number of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

deviceMinorNumber

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder deviceMinorNumber(long deviceMinorNumber)

Set the device minor version number of the entry. (This is relevant only to types where TapeArchiveEntryHeader.Type.isDevice() is true).

Parameters:

deviceMinorNumber - The device minor version number of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

filenamePrefix

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder filenamePrefix(String filenamePrefix)

Set the filename prefix of the entry.

This is the additional 155 characters that can be prepended to the TapeArchiveEntryHeader.name() to produce a full 255 character UNIX filename.

Parameters:

filenamePrefix - The filename prefix of the entry.

Returns:

The same TapeArchiveEntryHeader.UnixStandardEntryHeader.Builder.

build

public @NonNull TapeArchiveEntryHeader.UnixStandardEntryHeader build()

Build the TapeArchiveEntryHeader.UnixStandardEntryHeader.

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

Returns:

The built TapeArchiveEntryHeader.UnixStandardEntryHeader.