org.forgerock.opendj.ldap

Class AbstractAttribute

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractSet<ByteString>

org.forgerock.opendj.ldap.AbstractAttribute

All Implemented Interfaces:

Iterable<ByteString>, Collection<ByteString>, Set<ByteString>, Attribute

Direct Known Subclasses:

AbstractVirtualAttribute, LinkedAttribute

public abstract class AbstractAttribute
extends AbstractSet<ByteString>
implements Attribute

This class provides a skeletal implementation of the Attribute interface, to minimize the effort required to implement this interface.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAttribute() Sole constructor.

Method Summary

Modifier and Type	Method and Description
boolean	add(Object... values) Adds all of the provided attribute values to this attribute if they are not already present (optional operation).
boolean	addAll(Collection<? extends ByteString> values) Adds all of the attribute values contained in values to this attribute if they are not already present (optional operation).
<T> boolean	addAll(Collection<T> values, Collection<? super T> duplicateValues) Adds all of the attribute values contained in values to this attribute if they are not already present (optional operation).
boolean	contains(Object obj) Returns true if this attribute contains value.
boolean	containsAll(Collection<?> values) Returns true if this attribute contains all of the attribute values contained in values.
boolean	equals(Object object) Returns true if object is an attribute which is equal to this attribute.
ByteString	firstValue() Returns the first attribute value in this attribute.
int	hashCode() Returns the hash code for this attribute.
boolean	isEmpty() Returns true if this attribute contains no attribute values.
abstract Iterator<ByteString>	iterator() Returns an iterator over the attribute values in this attribute.
ConditionResult	matchesApproximateAssertion(Assertion assertion, ByteSequence rawAssertion) Indicates whether this attribute matches the specified assertion using the attribute's default approximate matching rule.
ConditionResult	matchesEqualityAssertion(Assertion assertion, ByteSequence rawAssertion) Indicates whether this attribute matches the specified assertion using the attribute's default equality matching rule.
ConditionResult	matchesGreaterOrEqualAssertion(Assertion assertion, ByteSequence rawAssertion) Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
ConditionResult	matchesLessOrEqualAssertion(Assertion assertion, ByteSequence rawAssertion) Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
ConditionResult	matchesSubstringAssertion(Assertion assertion, ByteSequence rawInitialSubstring, List<? extends ByteSequence> rawAnySubstrings, ByteSequence rawFinalSubstring) Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.
AttributeParser	parse() Returns a parser for this attribute which can be used for decoding values as different types of object.
boolean	removeAll(Collection<?> values) Removes all of the attribute values contained in values from this attribute if they are present (optional operation).
<T> boolean	removeAll(Collection<T> values, Collection<? super T> missingValues) Removes all of the attribute values contained in values from this attribute if they are present (optional operation).
boolean	retainAll(Collection<?> values) Retains only the attribute values in this attribute which are contained in values (optional operation).
<T> boolean	retainAll(Collection<T> values, Collection<? super T> missingValues) Retains only the attribute values in this attribute which are contained in values (optional operation).
int	size() Returns the number of attribute values in this attribute.
ByteString[]	toArray() Returns an array containing all of the attribute values contained in this attribute.
String	toString() Returns a string representation of this attribute.

Methods inherited from class java.util.AbstractCollection

add, clear, remove, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.forgerock.opendj.ldap.Attribute

add, clear, firstValueAsString, getAttributeDescription, getAttributeDescriptionAsString, isReal, isVirtual, remove, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

add, clear, remove, spliterator, toArray

Constructor Detail

AbstractAttribute

protected AbstractAttribute()

Sole constructor.

Method Detail

add

public boolean add(Object... values)

Description copied from interface: Attribute

Adds all of the provided attribute values to this attribute if they are not already present (optional operation).

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

add in interface Attribute

Parameters:

values - The attribute values to be added to this attribute.

Returns:

true if this attribute changed as a result of this call.

addAll

public boolean addAll(Collection<? extends ByteString> values)

Description copied from interface: Attribute

Adds all of the attribute values contained in values to this attribute if they are not already present (optional operation).

An invocation of this method is equivalent to:

 attribute.addAll(values, null);
 

Specified by:

addAll in interface Collection<ByteString>

Specified by:

addAll in interface Set<ByteString>

Specified by:

addAll in interface Attribute

Overrides:

addAll in class AbstractCollection<ByteString>

Parameters:

values - The attribute values to be added to this attribute.

Returns:

true if this attribute changed as a result of this call.

addAll

public <T> boolean addAll(Collection<T> values,
                          Collection<? super T> duplicateValues)

Description copied from interface: Attribute

Adds all of the attribute values contained in values to this attribute if they are not already present (optional operation). Any attribute values which are already present will be added to duplicateValues if specified.

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

addAll in interface Attribute

Type Parameters:

T - The type of the attribute value objects being added.

Parameters:

values - The attribute values to be added to this attribute.

duplicateValues - A collection into which duplicate values will be added, or null if duplicate values should not be saved.

Returns:

true if this attribute changed as a result of this call.

contains

public boolean contains(Object obj)

Description copied from interface: Attribute

Returns true if this attribute contains value.

If value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

contains in interface Collection<ByteString>

Specified by:

contains in interface Set<ByteString>

Specified by:

contains in interface Attribute

Overrides:

contains in class AbstractCollection<ByteString>

Parameters:

obj - The attribute value whose presence in this attribute is to be tested.

Returns:

true if this attribute contains value, or false if not.

containsAll

public boolean containsAll(Collection<?> values)

Description copied from interface: Attribute

Returns true if this attribute contains all of the attribute values contained in values.

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

containsAll in interface Collection<ByteString>

Specified by:

containsAll in interface Set<ByteString>

Specified by:

containsAll in interface Attribute

Overrides:

containsAll in class AbstractCollection<ByteString>

Parameters:

values - The attribute values whose presence in this attribute is to be tested.

Returns:

true if this attribute contains all of the attribute values contained in values, or false if not.

equals

public boolean equals(Object object)

Description copied from interface: Attribute

Returns true if object is an attribute which is equal to this attribute. Two attributes are considered equal if their attribute descriptions are equal, they both have the same number of attribute values, and every attribute value contained in the first attribute is also contained in the second attribute.

Specified by:

equals in interface Collection<ByteString>

Specified by:

equals in interface Set<ByteString>

Specified by:

equals in interface Attribute

Overrides:

equals in class AbstractSet<ByteString>

Parameters:

object - The object to be tested for equality with this attribute.

Returns:

true if object is an attribute which is equal to this attribute, or false if not.

firstValue

public ByteString firstValue()

Description copied from interface: Attribute

Returns the first attribute value in this attribute.

Specified by:

firstValue in interface Attribute

Returns:

The first attribute value in this attribute.

hashCode

public int hashCode()

Description copied from interface: Attribute

Returns the hash code for this attribute. It will be calculated as the sum of the hash codes of the attribute description and all of the attribute values.

Specified by:

hashCode in interface Collection<ByteString>

Specified by:

hashCode in interface Set<ByteString>

Specified by:

hashCode in interface Attribute

Overrides:

hashCode in class AbstractSet<ByteString>

Returns:

The hash code for this attribute.

parse

public AttributeParser parse()

Description copied from interface: Attribute

Returns a parser for this attribute which can be used for decoding values as different types of object.

Specified by:

parse in interface Attribute

Returns:

A parser for this attribute.

iterator

public abstract Iterator<ByteString> iterator()

Description copied from interface: Attribute

Returns an iterator over the attribute values in this attribute. The attribute values are returned in no particular order, unless the implementation of this attribute provides such a guarantee.

Specified by:

iterator in interface Iterable<ByteString>

Specified by:

iterator in interface Collection<ByteString>

Specified by:

iterator in interface Set<ByteString>

Specified by:

iterator in interface Attribute

Specified by:

iterator in class AbstractCollection<ByteString>

Returns:

An iterator over the attribute values in this attribute.

matchesApproximateAssertion

public ConditionResult matchesApproximateAssertion(Assertion assertion,
                                                   ByteSequence rawAssertion)

Description copied from interface: Attribute

Indicates whether this attribute matches the specified assertion using the attribute's default approximate matching rule.

Specified by:

matchesApproximateAssertion in interface Attribute

Parameters:

assertion - The attribute value assertion compiled using the attribute's default approximate matching rule.

rawAssertion - The raw assertion value whose syntax is compatible with the attribute's default approximate matching rule.

Returns:

ConditionResult.FALSE if the assertion does not match any values in this attribute, ConditionResult.TRUE if the assertion matches at least one value in this attribute, or ConditionResult.UNDEFINED if the assertion does not match any values in this attribute, but one or more values could not be compared because they are incompatible with the matching rule.

matchesEqualityAssertion

public ConditionResult matchesEqualityAssertion(Assertion assertion,
                                                ByteSequence rawAssertion)

Description copied from interface: Attribute

Indicates whether this attribute matches the specified assertion using the attribute's default equality matching rule.

Specified by:

matchesEqualityAssertion in interface Attribute

Parameters:

assertion - The attribute value assertion compiled using the attribute's default equality matching rule.

rawAssertion - The raw assertion value whose syntax is compatible with the attribute's default equality matching rule.

Returns:

ConditionResult.FALSE if the assertion does not match any values in this attribute, ConditionResult.TRUE if the assertion matches at least one value in this attribute, or ConditionResult.UNDEFINED if the assertion does not match any values in this attribute, but one or more values could not be compared because they are incompatible with the matching rule.

matchesGreaterOrEqualAssertion

public ConditionResult matchesGreaterOrEqualAssertion(Assertion assertion,
                                                      ByteSequence rawAssertion)

Description copied from interface: Attribute

Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.

Specified by:

matchesGreaterOrEqualAssertion in interface Attribute

Parameters:

assertion - The attribute value assertion compiled using the attribute's default ordering matching rule.

rawAssertion - The raw assertion value whose syntax is compatible with the attribute's default ordering matching rule.

Returns:

ConditionResult.FALSE if the assertion does not match any values in this attribute, ConditionResult.TRUE if the assertion matches at least one value in this attribute, or ConditionResult.UNDEFINED if the assertion does not match any values in this attribute, but one or more values could not be compared because they are incompatible with the matching rule.

matchesLessOrEqualAssertion

public ConditionResult matchesLessOrEqualAssertion(Assertion assertion,
                                                   ByteSequence rawAssertion)

Description copied from interface: Attribute

Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.

Specified by:

matchesLessOrEqualAssertion in interface Attribute

Parameters:

assertion - The attribute value assertion compiled using the attribute's default ordering matching rule.

rawAssertion - The raw assertion value whose syntax is compatible with the attribute's default ordering matching rule.

Returns:

ConditionResult.FALSE if the assertion does not match any values in this attribute, ConditionResult.TRUE if the assertion matches at least one value in this attribute, or ConditionResult.UNDEFINED if the assertion does not match any values in this attribute, but one or more values could not be compared because they are incompatible with the matching rule.

matchesSubstringAssertion

public ConditionResult matchesSubstringAssertion(Assertion assertion,
                                                 ByteSequence rawInitialSubstring,
                                                 List<? extends ByteSequence> rawAnySubstrings,
                                                 ByteSequence rawFinalSubstring)

Description copied from interface: Attribute

Indicates whether this attribute matches the specified assertion using the attribute's default ordering matching rule.

Specified by:

matchesSubstringAssertion in interface Attribute

Parameters:

assertion - The attribute value assertion compiled using the attribute's default ordering matching rule.

rawInitialSubstring - The assertion's initial sub-string, may be null if either rawFinalSubstring or rawAnySubstrings are specified.

rawAnySubstrings - The assertion's intermediate sub-strings, may be empty if either rawFinalSubstring or rawAnySubstrings are specified.

rawFinalSubstring - The final sub-string, may be null if either rawInitialSubstring or rawAnySubstrings are specified.

Returns:

ConditionResult.FALSE if the assertion does not match any values in this attribute, ConditionResult.TRUE if the assertion matches at least one value in this attribute, or ConditionResult.UNDEFINED if the assertion does not match any values in this attribute, but one or more values could not be compared because they are incompatible with the matching rule.

removeAll

public boolean removeAll(Collection<?> values)

Description copied from interface: Attribute

Removes all of the attribute values contained in values from this attribute if they are present (optional operation).

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

An invocation of this method is equivalent to:

 attribute.removeAll(values, null);
 

Specified by:

removeAll in interface Collection<ByteString>

Specified by:

removeAll in interface Set<ByteString>

Specified by:

removeAll in interface Attribute

Overrides:

removeAll in class AbstractSet<ByteString>

Parameters:

values - The attribute values to be removed from this attribute.

Returns:

true if this attribute changed as a result of this call.

removeAll

public <T> boolean removeAll(Collection<T> values,
                             Collection<? super T> missingValues)

Description copied from interface: Attribute

Removes all of the attribute values contained in values from this attribute if they are present (optional operation). Any attribute values which are not already present will be added to missingValues if specified.

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

removeAll in interface Attribute

Type Parameters:

T - The type of the attribute value objects being removed.

Parameters:

values - The attribute values to be removed from this attribute.

missingValues - A collection into which missing values will be added, or null if missing values should not be saved.

Returns:

true if this attribute changed as a result of this call.

retainAll

public boolean retainAll(Collection<?> values)

Description copied from interface: Attribute

Retains only the attribute values in this attribute which are contained in values (optional operation).

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

An invocation of this method is equivalent to:

 attribute.retainAll(values, null);
 

Specified by:

retainAll in interface Collection<ByteString>

Specified by:

retainAll in interface Set<ByteString>

Specified by:

retainAll in interface Attribute

Overrides:

retainAll in class AbstractCollection<ByteString>

Parameters:

values - The attribute values to be retained in this attribute.

Returns:

true if this attribute changed as a result of this call.

retainAll

public <T> boolean retainAll(Collection<T> values,
                             Collection<? super T> missingValues)

Description copied from interface: Attribute

Retains only the attribute values in this attribute which are contained in values (optional operation). Any attribute values which are not already present will be added to missingValues if specified.

Any attribute values which are not instances of ByteString will be converted using the ByteString.valueOfObject(Object) method.

Specified by:

retainAll in interface Attribute

Type Parameters:

T - The type of the attribute value objects being retained.

Parameters:

values - The attribute values to be retained in this attribute.

missingValues - A collection into which missing values will be added, or null if missing values should not be saved.

Returns:

true if this attribute changed as a result of this call.

isEmpty

public boolean isEmpty()

Description copied from interface: Attribute

Returns true if this attribute contains no attribute values.

Specified by:

isEmpty in interface Collection<ByteString>

Specified by:

isEmpty in interface Set<ByteString>

Specified by:

isEmpty in interface Attribute

Overrides:

isEmpty in class AbstractCollection<ByteString>

Returns:

true if this attribute contains no attribute values.

size

public int size()

Description copied from interface: Attribute

Returns the number of attribute values in this attribute.

Specified by:

size in interface Collection<ByteString>

Specified by:

size in interface Set<ByteString>

Specified by:

size in interface Attribute

Specified by:

size in class AbstractCollection<ByteString>

Returns:

The number of attribute values in this attribute.

toArray

public ByteString[] toArray()

Description copied from interface: Attribute

Returns an array containing all of the attribute values contained in this attribute.

If this attribute makes any guarantees as to what order its attribute values are returned by its iterator, this method must return the attribute values in the same order.

The returned array will be "safe" in that no references to it are maintained by this attribute. The caller is thus free to modify the returned array.

Specified by:

toArray in interface Collection<ByteString>

Specified by:

toArray in interface Set<ByteString>

Specified by:

toArray in interface Attribute

Overrides:

toArray in class AbstractCollection<ByteString>

Returns:

An array containing all of the attribute values contained in this attribute.

toString

public String toString()

Description copied from interface: Attribute

Returns a string representation of this attribute.

Specified by:

toString in interface Attribute

Overrides:

toString in class AbstractCollection<ByteString>

Returns:

The string representation of this attribute.