Added in API level 26

Summary: Nested Classes | Methods | Inherited Methods

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:

1. The type component determines if the entry grants or denies access.

2. The principal component, sometimes called the "who" component, is a UserPrincipal corresponding to the identity that the entry grants or denies access

3. The permissions component is a set of permissions

4. The flags component is a set of flags to 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 AclEntry objects.

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

From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public methods

equals

Added in API level 26

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

Added in API level 26

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

Added in API level 26

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

Added in API level 26

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

Added in API level 26

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

Added in API level 26

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

Added in API level 26

public UserPrincipal principal ()

Returns the principal component.

Returns
UserPrincipal	the principal component

toString

Added in API level 26

public String toString ()

Returns the string representation of this ACL entry.

Returns
String	the string representation of this entry

type

Added in API level 26

public AclEntryType type ()

Returns the ACL entry type.

Returns
AclEntryType	the ACL entry type