Class PosixFilePermissions
- java.lang.Object
-
- java.nio.file.attribute.PosixFilePermissions
-
public final class PosixFilePermissions extends Object
This class consists exclusively of static methods that operate on sets ofPosixFilePermission
objects.- Since:
- 1.7
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method and Description static FileAttribute<Set<PosixFilePermission>>
asFileAttribute(Set<PosixFilePermission> perms)
Creates aFileAttribute
, encapsulating a copy of the given file permissions, suitable for passing to thecreateFile
orcreateDirectory
methods.static Set<PosixFilePermission>
fromString(String perms)
Returns the set of permissions corresponding to a givenString
representation.static String
toString(Set<PosixFilePermission> perms)
Returns theString
representation of a set of permissions.
-
-
-
Method Detail
toString
public static String toString(Set<PosixFilePermission> perms)
Returns theString
representation of a set of permissions. It is guaranteed that the returnedString
can be parsed by thefromString(java.lang.String)
method.If the set contains
null
or elements that are not of typePosixFilePermission
then these elements are ignored.- Parameters:
-
perms
- the set of permissions - Returns:
- the string representation of the permission set
fromString
public static Set<PosixFilePermission> fromString(String perms)
Returns the set of permissions corresponding to a givenString
representation.The
perms
parameter is aString
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 representing a set of permissions - Returns:
- the resulting set of permissions
- Throws:
-
IllegalArgumentException
- if the string cannot be converted to a set of permissions - See Also:
-
toString(Set)
asFileAttribute
public static FileAttribute<Set<PosixFilePermission>> asFileAttribute(Set<PosixFilePermission> perms)
Creates aFileAttribute
, encapsulating a copy of the given file permissions, suitable for passing to thecreateFile
orcreateDirectory
methods.- Parameters:
-
perms
- the set of permissions - Returns:
-
an attribute encapsulating the given file permissions with
name
"posix:permissions"
- Throws:
-
ClassCastException
- if the set contains elements that are not of typePosixFilePermission
-
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2022, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.