AclEntry.Builder

AI-generated Key Takeaways

• AclEntry.Builder objects are used to construct AclEntry objects, which define access control rules for files and directories.

• You can set permissions, flags, principal, and type using the builder's methods before building the final AclEntry.

• AclEntry.Builder is not thread-safe and requires synchronization for concurrent use.

• The build() method creates an AclEntry instance but requires the type and principal components to have been set beforehand.

• Builder methods like setFlags and setPermissions accept sets or arrays of corresponding types to configure the AclEntry.

public static final class AclEntry.Builder extends Object

A builder of AclEntry objects.

A Builder object is obtained by invoking one of the newBuilder methods defined by the AclEntry class.

Builder objects are mutable and are not safe for use by multiple concurrent threads without appropriate synchronization.

Public Method Summary

AclEntry	build() Constructs an AclEntry from the components of this builder.
AclEntry.Builder	setFlags(Set<AclEntryFlag> flags) Sets the flags component of this builder.
AclEntry.Builder	setFlags(AclEntryFlag... flags) Sets the flags component of this builder.
AclEntry.Builder	setPermissions(Set<AclEntryPermission> perms) Sets the permissions component of this builder.
AclEntry.Builder	setPermissions(AclEntryPermission... perms) Sets the permissions component of this builder.
AclEntry.Builder	setPrincipal(UserPrincipal who) Sets the principal component of this builder.
AclEntry.Builder	setType(AclEntryType type) Sets the type component of this builder.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
final void	notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up.
String	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(long timeout, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait(long timeout) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.
final void	wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Public Methods

public AclEntry build ()

Constructs an AclEntry from the components of this builder. The type and who components are required to have been set in order to construct an AclEntry.

Returns

• a new ACL entry

Throws

IllegalStateException	if the type or who component have not been set

public AclEntry.Builder setFlags (Set<AclEntryFlag> flags)

Sets the flags component of this builder. On return, the flags component of this builder is a copy of the given set.

Parameters

flags	the flags component

Returns

• this builder

Throws

ClassCastException	if the set contains elements that are not of type AclEntryFlag

public AclEntry.Builder setFlags (AclEntryFlag... flags)

Sets the flags component of this builder. On return, the flags component of this builder is a copy of the flags in the given array.

Parameters

flags	the flags component

Returns

• this builder

public AclEntry.Builder setPermissions (Set<AclEntryPermission> perms)

Sets the permissions component of this builder. On return, the permissions component of this builder is a copy of the given set.

Parameters

perms	the permissions component

Returns

• this builder

Throws

ClassCastException	if the set contains elements that are not of type AclEntryPermission

public AclEntry.Builder setPermissions (AclEntryPermission... perms)

Sets the permissions component of this builder. On return, the permissions component of this builder is a copy of the permissions in the given array.

Parameters

perms	the permissions component

Returns

• this builder

public AclEntry.Builder setPrincipal (UserPrincipal who)

Sets the principal component of this builder.

Parameters

who	the principal component

Returns

• this builder

public AclEntry.Builder setType (AclEntryType type)

Sets the type component of this builder.

Parameters

type	the component type

Returns

• this builder