PosixFilePermissions (Java Platform SE 8 ) (original) (raw)

• 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	Description
  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.
  static Set<PosixFilePermission>	fromString(String perms)	Returns the set of permissions corresponding to a given String representation.
  static String	toString(Set<PosixFilePermission> perms)	Returns the String representation of a set of permissions.

     * ### Methods inherited from class java.lang.[Object](../../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../../java/lang/Object.html#clone--), [equals](../../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../../java/lang/Object.html#finalize--), [getClass](../../../../java/lang/Object.html#getClass--), [hashCode](../../../../java/lang/Object.html#hashCode--), [notify](../../../../java/lang/Object.html#notify--), [notifyAll](../../../../java/lang/Object.html#notifyAll--), [toString](../../../../java/lang/Object.html#toString--), [wait](../../../../java/lang/Object.html#wait--), [wait](../../../../java/lang/Object.html#wait-long-), [wait](../../../../java/lang/Object.html#wait-long-int-)`

• • Method Detail

     * #### toString  
     public static [String](../../../../java/lang/String.html "class in java.lang") toString([Set](../../../../java/util/Set.html "interface in java.util")<[PosixFilePermission](../../../../java/nio/file/attribute/PosixFilePermission.html "enum in java.nio.file.attribute")> perms)  
     Returns the `String` representation of a set of permissions. It is guaranteed that the returned `String` can be parsed by the[fromString(java.lang.String)](../../../../java/nio/file/attribute/PosixFilePermissions.html#fromString-java.lang.String-) method.  
      If the set contains `null` or elements that are not of type`PosixFilePermission` then these elements are ignored.  
     Parameters:  
     `perms` \- the set of permissions  
     Returns:  
     the string representation of the permission set  
     * #### fromString  
     public static [Set](../../../../java/util/Set.html "interface in java.util")<[PosixFilePermission](../../../../java/nio/file/attribute/PosixFilePermission.html "enum in java.nio.file.attribute")> fromString([String](../../../../java/lang/String.html "class in java.lang") 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---");  
            
     Parameters:  
     `perms` \- string representing a set of permissions  
     Returns:  
     the resulting set of permissions  
     Throws:  
     `[IllegalArgumentException](../../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if the string cannot be converted to a set of permissions  
     See Also:  
     [toString(Set)](../../../../java/nio/file/attribute/PosixFilePermissions.html#toString-java.util.Set-)  
     * #### asFileAttribute  
     public static [FileAttribute](../../../../java/nio/file/attribute/FileAttribute.html "interface in java.nio.file.attribute")<[Set](../../../../java/util/Set.html "interface in java.util")<[PosixFilePermission](../../../../java/nio/file/attribute/PosixFilePermission.html "enum in java.nio.file.attribute")>> asFileAttribute([Set](../../../../java/util/Set.html "interface in java.util")<[PosixFilePermission](../../../../java/nio/file/attribute/PosixFilePermission.html "enum in java.nio.file.attribute")> perms)  
     Parameters:  
     `perms` \- the set of permissions  
     Returns:  
     an attribute encapsulating the given file permissions with[name](../../../../java/nio/file/attribute/FileAttribute.html#name--) `"posix:permissions"`  
     Throws:  
     `[ClassCastException](../../../../java/lang/ClassCastException.html "class in java.lang")` \- if the set contains elements that are not of type `PosixFilePermission`

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, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.