Module com.github.robtimus.filesystems

Package com.github.robtimus.filesystems.attribute

Class PosixFilePermissionSupport

java.lang.Object

com.github.robtimus.filesystems.attribute.PosixFilePermissionSupport

public final class PosixFilePermissionSupport
extends Object

A utility class for PosixFilePermission.

Author:

Rob Spoor

Since:

1.1

Method Summary

Modifier and Type	Method	Description
static Set<PosixFilePermission>	fromMask(int mask)	Returns the set of permissions corresponding to a permission bit mask.
static boolean	hasPermission(int mask, PosixFilePermission permission)	Returns whether or not a specific permission is set in a permission bit mask.
static int	toMask(Set<PosixFilePermission> permissions)	Returns a permission bit mask corresponding to a set of permissions.

Methods inherited from class java.lang.Object

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

Method Detail

fromMask

public static Set<PosixFilePermission> fromMask(int mask)

Returns the set of permissions corresponding to a permission bit mask. This method uses the most usual mapping:

• 0400 maps to PosixFilePermission.OWNER_READ
• 0200 maps to PosixFilePermission.OWNER_WRITE
• 0100 maps to PosixFilePermission.OWNER_EXECUTE
• 0040 maps to PosixFilePermission.GROUP_READ
• 0020 maps to PosixFilePermission.GROUP_WRITE
• 0010 maps to PosixFilePermission.GROUP_EXECUTE
• 0004 maps to PosixFilePermission.OTHERS_READ
• 0002 maps to PosixFilePermission.OTHERS_WRITE
• 0001 maps to PosixFilePermission.OTHERS_EXECUTE

Parameters:

mask - The bit mask representing a set of permissions.

Returns:

The resulting set of permissions.

toMask

public static int toMask(Set<PosixFilePermission> permissions)

Returns a permission bit mask corresponding to a set of permissions. This method is the inverse of fromMask(int).

Parameters:

permissions - The set of permissions.

Returns:

The resulting permission bit mask.

Throws:

NullPointerException - If the given set is null.

hasPermission

public static boolean hasPermission(int mask,
                                    PosixFilePermission permission)

Returns whether or not a specific permission is set in a permission bit mask.

More formally, this method returns true only if the given permission is contained in the set returned by fromMask(int).

Parameters:

mask - The permission bit mask to check.

permission - The permission to check for.

Returns:

true if the permission is set in the given permission bit mask, or false otherwise.

Throws:

NullPointerException - If the given set is null.