AclEntry
public
final
class
AclEntry
extends Object
| java.lang.Object | |
| ↳ | java.nio.file.attribute.AclEntry |
An entry in an access control list (ACL).
The ACL entry represented by this class is based on the ACL model specified in RFC 3530: Network File System (NFS) version 4 Protocol. Each entry has four components as follows:
The
typecomponent determines if the entry grants or denies access.The
principalcomponent, sometimes called the "who" component, is aUserPrincipalcorresponding to the identity that the entry grants or denies accessThe
permissionscomponent is a set ofpermissionsThe
flagscomponent is a set offlagsto indicate how entries are inherited and propagated
ACL entries are created using an associated Builder object by
invoking its build method.
ACL entries are immutable and are safe for use by multiple concurrent threads.
Summary
Nested classes | |
|---|---|
class |
AclEntry.Builder
A builder of |
Public methods | |
|---|---|
boolean
|
equals(Object ob)
Compares the specified object with this ACL entry for equality. |
Set<AclEntryFlag>
|
flags()
Returns a copy of the flags component. |
int
|
hashCode()
Returns the hash-code value for this ACL entry. |
static
AclEntry.Builder
|
newBuilder(AclEntry entry)
Constructs a new builder with the components of an existing ACL entry. |
static
AclEntry.Builder
|
newBuilder()
Constructs a new builder. |
Set<AclEntryPermission>
|
permissions()
Returns a copy of the permissions component. |
UserPrincipal
|
principal()
Returns the principal component. |
String
|
toString()
Returns the string representation of this ACL entry. |
AclEntryType
|
type()
Returns the ACL entry type. |
Inherited methods | |
|---|---|
Public methods
equals
public boolean equals (Object ob)
Compares the specified object with this ACL entry for equality.
If the given object is not an AclEntry then this method
immediately returns false.
For two ACL entries to be considered equals requires that they are both the same type, their who components are equal, their permissions components are equal, and their flags components are equal.
This method satisfies the general contract of the Object.equals method.
| Parameters | |
|---|---|
ob |
Object: the object to which this object is to be compared |
| Returns | |
|---|---|
boolean |
true if, and only if, the given object is an AclEntry that
is identical to this AclEntry |
flags
public Set<AclEntryFlag> flags ()
Returns a copy of the flags component.
The returned set is a modifiable copy of the flags.
| Returns | |
|---|---|
Set<AclEntryFlag> |
the flags component |
hashCode
public int hashCode ()
Returns the hash-code value for this ACL entry.
This method satisfies the general contract of the Object.hashCode() method.
| Returns | |
|---|---|
int |
a hash code value for this object. |
newBuilder
public static AclEntry.Builder newBuilder (AclEntry entry)
Constructs a new builder with the components of an existing ACL entry.
| Parameters | |
|---|---|
entry |
AclEntry: an ACL entry |
| Returns | |
|---|---|
AclEntry.Builder |
a new builder |
newBuilder
public static AclEntry.Builder newBuilder ()
Constructs a new builder. The initial value of the type and who
components is null. The initial value of the permissions and
flags components is the empty set.
| Returns | |
|---|---|
AclEntry.Builder |
a new builder |
permissions
public Set<AclEntryPermission> permissions ()
Returns a copy of the permissions component.
The returned set is a modifiable copy of the permissions.
| Returns | |
|---|---|
Set<AclEntryPermission> |
the permissions component |
principal
public UserPrincipal principal ()
Returns the principal component.
| Returns | |
|---|---|
UserPrincipal |
the principal component |
toString
public String toString ()
Returns the string representation of this ACL entry.
| Returns | |
|---|---|
String |
the string representation of this entry |
type
public AclEntryType type ()
Returns the ACL entry type.
| Returns | |
|---|---|
AclEntryType |
the ACL entry type |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.