Package org.xmldb.api.security

Class AclEntry

java.lang.Object

org.xmldb.api.security.AclEntry

public final class AclEntry
extends java.lang.Object

An entry in an access control list (ACL).

Since:

2.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AclEntry.Builder	A builder of AclEntry objects.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)	Compares the specified object with this ACL entry for equality.
java.util.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()	Constructs a new builder.
static AclEntry.Builder	newBuilder(AclEntry entry)	Constructs a new builder with the components of an existing ACL entry.
java.util.Set<AclEntryPermission>	permissions()	Returns a copy of the permissions component.
AccountPrincipal	principal()	Returns the principal component.
java.lang.String	toString()	Returns the string representation of this ACL entry.
AclEntryType	type()	Returns the ACL entry type.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public static AclEntry.Builder newBuilder()

Constructs a new builder. The initial value of the type and principal components is null. The initial value of the permissions and flags components is the empty set.

Returns:

a new builder

newBuilder

public static AclEntry.Builder newBuilder(AclEntry entry)

Constructs a new builder with the components of an existing ACL entry.

Parameters:

entry - an ACL entry

Returns:

a new builder

principal

public AccountPrincipal principal()

Returns the principal component.

Returns:

the principal of the ACL entry.

type

public AclEntryType type()

Returns the ACL entry type.

Returns:

the type of the ACL entry.

permissions

public java.util.Set<AclEntryPermission> permissions()

Returns a copy of the permissions component.

Returns:

the permissions of the ACL entry.

flags

public java.util.Set<AclEntryFlag> flags()

Returns a copy of the flags component.

Returns:

the flags of the ACL entry.

equals

public boolean equals(java.lang.Object obj)

Compares the specified object with this ACL entry for equality. Returns true if the object passed in matches the ACL entry represented by the implementation of this interface.

Overrides:

equals in class java.lang.Object

Parameters:

obj - - the object to which this object is to be compared

Returns:

true if, and only if, the given object is an AclEntry that is identical to this AclEntry

hashCode

public int hashCode()

Returns the hash-code value for this ACL entry.

Overrides:

hashCode in class java.lang.Object

Returns:

a hash code value for this object.

toString

public java.lang.String toString()

Returns the string representation of this ACL entry.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the ACL entry.