APIdia Launch Partner
Top Description Constructors Methods
java.nio.file.attribute

public final Class PosixFilePermissions

extends Object
Class Inheritance
Static Imports
java.nio.file.attribute.PosixFilePermission.*

This class consists exclusively of static methods that operate on sets of PosixFilePermission objects.
Since
1.7

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public static FileAttribute<Set<PosixFilePermission>>

Returns:

an attribute encapsulating the given file permissions with name "posix:permissions"
asFileAttribute
(Set<PosixFilePermission>
the set of permissions
perms
)

Creates a FileAttribute, encapsulating a copy of the given file permissions, suitable for passing to the createFile or createDirectory methods.

public static Set<PosixFilePermission>

Returns:

the resulting set of permissions
fromString
(String
string representing a set of permissions
perms
)

Returns the set of permissions corresponding to a given String representation.

private static boolean
isR(char c)

private static boolean
isSet(char c, char setValue)

private static boolean
isW(char c)

private static boolean
isX(char c)

public static String

Returns:

the string representation of the permission set
toString
(Set<PosixFilePermission>
the set of permissions
perms
)

Returns the String representation of a set of permissions.

private static void
writeBits(StringBuilder sb, boolean r, boolean w, boolean x)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

PosixFilePermissionsback to summary
private PosixFilePermissions()

Method Detail

asFileAttributeback to summary
public static FileAttribute<Set<PosixFilePermission>> asFileAttribute(Set<PosixFilePermission> perms)

Creates a FileAttribute, encapsulating a copy of the given file permissions, suitable for passing to the createFile or createDirectory methods.

Parameters
perms:Set<PosixFilePermission>

the set of permissions

Returns:FileAttribute<Set<PosixFilePermission>>

an attribute encapsulating the given file permissions with name "posix:permissions"

Exceptions
ClassCastException:
if the set contains elements that are not of type PosixFilePermission
fromStringback to summary
public static Set<PosixFilePermission> fromString(String perms)

Returns the set of permissions corresponding to a given String representation.

The perms parameter is a String representing the permissions. It has 9 characters that are interpreted as three sets of three. The first set refers to the owner's permissions; the next to the group permissions and the last to others. Within each set, the first character is 'r' to indicate permission to read, the second character is 'w' to indicate permission to write, and the third character is 'x' for execute permission. Where a permission is not set then the corresponding character is set to '-'.

Usage Example: Suppose we require the set of permissions that indicate the owner has read, write, and execute permissions, the group has read and execute permissions and others have none.

Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rwxr-x---");
Set<PosixFilePermission> perms = PosixFilePermissions.fromString("rwxr-x---");
Parameters
perms:String

string representing a set of permissions

Returns:Set<PosixFilePermission>

the resulting set of permissions

Exceptions
IllegalArgumentException:
if the string cannot be converted to a set of permissions
See Also
toString(Set)
isRback to summary
private static boolean isR(char c)
isSetback to summary
private static boolean isSet(char c, char setValue)
isWback to summary
private static boolean isW(char c)
isXback to summary
private static boolean isX(char c)
toStringback to summary
public static String toString(Set<PosixFilePermission> perms)

Returns the String representation of a set of permissions. It is guaranteed that the returned String can be parsed by the fromString method.

If the set contains null or elements that are not of type PosixFilePermission then these elements are ignored.

Parameters
perms:Set<PosixFilePermission>

the set of permissions

Returns:String

the string representation of the permission set

writeBitsback to summary
private static void writeBits(StringBuilder sb, boolean r, boolean w, boolean x)