Package org.forgerock.opendj.ldap

Class LinkedAttribute

java.lang.Object

java.util.AbstractCollection<ByteString>

java.util.AbstractSet<ByteString>

org.forgerock.opendj.ldap.AbstractAttribute

org.forgerock.opendj.ldap.LinkedAttribute

All Implemented Interfaces:

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

public final class LinkedAttribute
extends AbstractAttribute

An implementation of the Attribute interface with predictable iteration order.

Internally, attribute values are stored in a linked list and it's this list which defines the iteration ordering, which is the order in which elements were inserted into the set (insertion-order). This ordering is particularly useful in LDAP where clients generally appreciate having things returned in the same order they were presented.

All operations are supported by this implementation.

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeFactory	FACTORY	An attribute factory which can be used to create new linked attributes.

Constructor Summary

Constructors

Constructor	Description
LinkedAttribute(String attributeDescription)	Creates a new attribute having the specified attribute description and no attribute values.
LinkedAttribute(String attributeDescription, Object value)	Creates a new attribute having the specified attribute description and single attribute value.
LinkedAttribute(String attributeDescription, Object... values)	Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(String attributeDescription, Collection<?> values)	Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(Attribute attribute)	Creates a new attribute having the same attribute description and attribute values as attribute.
LinkedAttribute(AttributeDescription attributeDescription)	Creates a new attribute having the specified attribute description and no attribute values.
LinkedAttribute(AttributeDescription attributeDescription, Object value)	Creates a new attribute having the specified attribute description and single attribute value.
LinkedAttribute(AttributeDescription attributeDescription, Object... values)	Creates a new attribute having the specified attribute description and attribute values.
LinkedAttribute(AttributeDescription attributeDescription, Collection<?> values)	Creates a new attribute having the specified attribute description and attribute values.

Method Summary

Modifier and Type	Method	Description
boolean	add(ByteString value)	Adds value to this attribute if it is not already present (optional operation).
void	clear()	Removes all of the attribute values from this attribute (optional operation).
boolean	contains(Object value)	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.
ByteString	firstValue()	Returns the first attribute value in this attribute.
AttributeDescription	getAttributeDescription()	Returns the attribute description of this attribute, which includes its attribute type and any options.
Iterator<ByteString>	iterator()	Returns an iterator over the attribute values in this attribute.
boolean	remove(Object value)	Removes value from this attribute if it is present (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.

Methods inherited from class org.forgerock.opendj.ldap.AbstractAttribute

add, addAll, addAll, equals, firstValueAsString, getAttributeDescriptionAsString, hashCode, parse, removeAll, removeAll, retainAll, toArray, toString

Methods inherited from class java.util.AbstractCollection

isEmpty, 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

isEmpty, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.Set

spliterator

Field Details

FACTORY

public static final AttributeFactory FACTORY

An attribute factory which can be used to create new linked attributes.

Constructor Details

LinkedAttribute

public LinkedAttribute(Attribute attribute)

Creates a new attribute having the same attribute description and attribute values as attribute.

Parameters:

attribute - The attribute to be copied.

Throws:

NullPointerException - If attribute was null.

LinkedAttribute

public LinkedAttribute(AttributeDescription attributeDescription)

Creates a new attribute having the specified attribute description and no attribute values.

Parameters:

attributeDescription - The attribute description.

Throws:

NullPointerException - If attributeDescription was null.

LinkedAttribute

public LinkedAttribute(AttributeDescription attributeDescription,
 Object value)

Creates a new attribute having the specified attribute description and single attribute value.

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

Parameters:

attributeDescription - The attribute description.

value - The single attribute value.

Throws:

NullPointerException - If attributeDescription or value was null .

LinkedAttribute

public LinkedAttribute(AttributeDescription attributeDescription,
 Object... values)

Creates a new attribute having the specified attribute description and attribute values.

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

Parameters:

attributeDescription - The attribute description.

values - The attribute values.

Throws:

NullPointerException - If attributeDescription or values was null.

LinkedAttribute

public LinkedAttribute(AttributeDescription attributeDescription,
 Collection<?> values)

Creates a new attribute having the specified attribute description and attribute values.

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

Parameters:

attributeDescription - The attribute description.

values - The attribute values.

Throws:

NullPointerException - If attributeDescription or values was null.

LinkedAttribute

public LinkedAttribute(String attributeDescription)

Creates a new attribute having the specified attribute description and no attribute values. The attribute description will be decoded using the default schema.

Parameters:

attributeDescription - The attribute description.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using the default schema.

NullPointerException - If attributeDescription was null.

LinkedAttribute

public LinkedAttribute(String attributeDescription,
 Collection<?> values)

Creates a new attribute having the specified attribute description and attribute values. The attribute description will be decoded using the default schema.

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

Parameters:

attributeDescription - The attribute description.

values - The attribute values.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using the default schema.

NullPointerException - If attributeDescription or values was null.

LinkedAttribute

public LinkedAttribute(String attributeDescription,
 Object value)

Creates a new attribute having the specified attribute description and single attribute value. The attribute description will be decoded using the default schema.

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

Parameters:

attributeDescription - The attribute description.

value - The single attribute value.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using the default schema.

NullPointerException - If attributeDescription or value was null .

LinkedAttribute

public LinkedAttribute(String attributeDescription,
 Object... values)

Creates a new attribute having the specified attribute description and attribute values. The attribute description will be decoded using the default schema.

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

Parameters:

attributeDescription - The attribute description.

values - The attribute values.

Throws:

org.forgerock.i18n.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using the default schema.

NullPointerException - If attributeDescription or values was null.

Method Details

add

public boolean add(ByteString value)

Description copied from interface: Attribute

Adds value to this attribute if it is not already present (optional operation). If this attribute already contains value, the call leaves the attribute unchanged and returns false.

Specified by:

add in interface Attribute

Specified by:

add in interface Collection<ByteString>

Specified by:

add in interface Set<ByteString>

Specified by:

add in class AbstractAttribute

Parameters:

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

Returns:

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

clear

public void clear()

Description copied from interface: Attribute

Removes all of the attribute values from this attribute (optional operation). This attribute will be empty after this call returns.

Specified by:

clear in interface Attribute

Specified by:

clear in interface Collection<ByteString>

Specified by:

clear in interface Set<ByteString>

Overrides:

clear in class AbstractCollection<ByteString>

contains

public boolean contains(Object value)

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 Attribute

Specified by:

contains in interface Collection<ByteString>

Specified by:

contains in interface Set<ByteString>

Specified by:

contains in class AbstractAttribute

Parameters:

value - 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 Attribute

Specified by:

containsAll in interface Collection<ByteString>

Specified by:

containsAll in interface Set<ByteString>

Overrides:

containsAll in class AbstractAttribute

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.

firstValue

public ByteString firstValue()

Description copied from interface: Attribute

Returns the first attribute value in this attribute.

Specified by:

firstValue in interface Attribute

Overrides:

firstValue in class AbstractAttribute

Returns:

The first attribute value in this attribute.

getAttributeDescription

public AttributeDescription getAttributeDescription()

Description copied from interface: Attribute

Returns the attribute description of this attribute, which includes its attribute type and any options.

Specified by:

getAttributeDescription in interface Attribute

Specified by:

getAttributeDescription in class AbstractAttribute

Returns:

The attribute description.

iterator

public 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 Attribute

Specified by:

iterator in interface Collection<ByteString>

Specified by:

iterator in interface Iterable<ByteString>

Specified by:

iterator in interface Set<ByteString>

Specified by:

iterator in class AbstractAttribute

Returns:

An iterator over the attribute values in this attribute.

remove

public boolean remove(Object value)

Description copied from interface: Attribute

Removes value from this attribute if it is present (optional operation). If this attribute does not contain value, the call leaves the attribute unchanged and returns false.

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

Specified by:

remove in interface Attribute

Specified by:

remove in interface Collection<ByteString>

Specified by:

remove in interface Set<ByteString>

Specified by:

remove in class AbstractAttribute

Parameters:

value - The attribute value to be removed from 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

Overrides:

retainAll in class AbstractAttribute

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.

size

public int size()

Description copied from interface: Attribute

Returns the number of attribute values in this attribute.

Specified by:

size in interface Attribute

Specified by:

size in interface Collection<ByteString>

Specified by:

size in interface Set<ByteString>

Specified by:

size in class AbstractAttribute

Returns:

The number of attribute values in this attribute.