Module xyz.apollosoftware.bibliothiki.compression

Package xyz.apollosoftware.bibliothiki.compression

Record Class ArchiveEntry.PermissionSet

java.lang.Object

java.lang.Record

xyz.apollosoftware.bibliothiki.compression.ArchiveEntry.PermissionSet

Record Components:

user - The user (owner) permissions.

group - The group (owner) permissions.

world - The world (non-owner) permissions.

Enclosing class:

ArchiveEntry

public static record ArchiveEntry.PermissionSet(@NonNull ArchiveEntry.Permission user, @NonNull ArchiveEntry.Permission group, @NonNull ArchiveEntry.Permission world)
extends Record

A set of permissions.

This covers the UNIX permissions values for user, group and world (other) permissions. Each permission within the set is represented by a ArchiveEntry.Permission value.

Constructor Summary

Constructors

Constructor	Description
PermissionSet(@NonNull ArchiveEntry.Permission user, @NonNull ArchiveEntry.Permission group, @NonNull ArchiveEntry.Permission world)	Creates an instance of a PermissionSet record class.

Method Summary

Modifier and Type	Method	Description
static @NonNull ArchiveEntry.PermissionSet	decode(long mode)	Decode the permission set from the numeric value.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NonNull ArchiveEntry.Permission	group()	Returns the value of the group record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
@NonNull ArchiveEntry.Permission	user()	Returns the value of the user record component.
@NonNull ArchiveEntry.Permission	world()	Returns the value of the world record component.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PermissionSet

public PermissionSet(@NonNull ArchiveEntry.Permission user,
 @NonNull ArchiveEntry.Permission group,
 @NonNull ArchiveEntry.Permission world)

Creates an instance of a PermissionSet record class.

Parameters:

user - the value for the user record component

group - the value for the group record component

world - the value for the world record component

Method Details

decode

public static @NonNull ArchiveEntry.PermissionSet decode(long mode)

Decode the permission set from the numeric value.

This method assumes there are three octal digits starting in the least significant bit position - in the order user, group then world. (That is, the world permission digit is expected to be the least significant three octets).

Parameters:

mode - The mode value to decode.

Returns:

The decoded ArchiveEntry.PermissionSet.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

user

public @NonNull ArchiveEntry.Permission user()

Returns the value of the user record component.

Returns:

the value of the user record component

group

public @NonNull ArchiveEntry.Permission group()

Returns the value of the group record component.

Returns:

the value of the group record component

world

public @NonNull ArchiveEntry.Permission world()

Returns the value of the world record component.

Returns:

the value of the world record component