Added in API level 26

PosixFilePermissions

class PosixFilePermissions
kotlin.Any
   ↳ java.nio.file.attribute.PosixFilePermissions

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

Summary

Public methods
static FileAttribute<MutableSet<PosixFilePermission!>!>!

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

static MutableSet<PosixFilePermission!>!
fromString(perms: String!)

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

static String!

Returns the String representation of a set of permissions.

Public methods

asFileAttribute

Added in API level 26
static fun asFileAttribute(perms: MutableSet<PosixFilePermission!>!): FileAttribute<MutableSet<PosixFilePermission!>!>!

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

Parameters
perms MutableSet<PosixFilePermission!>!: the set of permissions
Return
FileAttribute<MutableSet<PosixFilePermission!>!>! an attribute encapsulating the given file permissions with name "posix:permissions"
Exceptions
java.lang.ClassCastException if the set contains elements that are not of type PosixFilePermission

fromString

Added in API level 26
static fun fromString(perms: String!): MutableSet<PosixFilePermission!>!

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---");
  
Parameters
perms String!: string representing a set of permissions
Return
MutableSet<PosixFilePermission!>! the resulting set of permissions
Exceptions
java.lang.IllegalArgumentException if the string cannot be converted to a set of permissions

See Also

toString

Added in API level 26
static fun toString(perms: MutableSet<PosixFilePermission!>!): String!

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 MutableSet<PosixFilePermission!>!: the set of permissions
Return
String! the string representation of the permission set