public interface Attribute extends Set<ByteString>
Any methods which perform comparisons between attribute values use the equality matching rule associated with the attribute description.
Any methods which accept Object based attribute values convert the
attribute values to instances of ByteString using
ByteString.valueOf(Object).
| Modifier and Type | Method and Description |
|---|---|
boolean |
add(ByteString value)
Adds
value to this attribute if it is not already present
(optional operation). |
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). |
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. |
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.
|
String |
firstValueAsString()
Returns the first attribute value in this attribute decoded as a UTF-8
string.
|
AttributeDescription |
getAttributeDescription()
Returns the attribute description of this attribute, which includes its
attribute type and any options.
|
String |
getAttributeDescriptionAsString()
Returns the string representation of the attribute description of this
attribute, which includes its attribute type and any options.
|
int |
hashCode()
Returns the hash code for this attribute.
|
boolean |
isEmpty()
Returns
true if this attribute contains no attribute values. |
Iterator<ByteString> |
iterator()
Returns an iterator over the attribute values in this attribute.
|
AttributeParser |
parse()
Returns a parser for this attribute which can be used for decoding values
as different types of object.
|
boolean |
remove(Object value)
Removes
value from this attribute if it is present (optional
operation). |
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.
|
<T> T[] |
toArray(T[] array)
Returns an array containing all of the attribute values in this
attribute; the runtime type of the returned array is that of the
specified array.
|
String |
toString()
Returns a string representation of this attribute.
|
boolean add(ByteString value)
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.add in interface Collection<ByteString>add in interface Set<ByteString>value - The attribute value to be added to this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support addition of attribute
values.NullPointerException - If value was null.boolean add(Object... values)
Any attribute values which are not instances of ByteString will
be converted using the ByteString.valueOf(Object) method.
values - The attribute values to be added to this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support addition of attribute
values.NullPointerException - If values was null.boolean addAll(Collection<? extends ByteString> values)
values to this
attribute if they are not already present (optional operation).
An invocation of this method is equivalent to:
attribute.addAll(values, null);
addAll in interface Collection<ByteString>addAll in interface Set<ByteString>values - The attribute values to be added to this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support addition of attribute
values.NullPointerException - If values was null.<T> boolean addAll(Collection<T> values, Collection<? super T> duplicateValues)
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.valueOf(Object) method.
T - The type of the attribute value objects being added.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.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support addition of attribute
values.NullPointerException - If values was null.void clear()
clear in interface Collection<ByteString>clear in interface Set<ByteString>UnsupportedOperationException - If this attribute does not support removal of attribute
values.boolean contains(Object value)
true if this attribute contains value.
If value is not an instance of ByteString then it will be
converted using the ByteString.valueOf(Object) method.
contains in interface Collection<ByteString>contains in interface Set<ByteString>value - The attribute value whose presence in this attribute is to be
tested.true if this attribute contains value, or
false if not.NullPointerException - If value was null.boolean containsAll(Collection<?> values)
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.valueOf(Object) method.
containsAll in interface Collection<ByteString>containsAll in interface Set<ByteString>values - The attribute values whose presence in this attribute is to be
tested.true if this attribute contains all of the attribute
values contained in values, or false if not.NullPointerException - If values was null.boolean equals(Object object)
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.equals in interface Collection<ByteString>equals in interface Set<ByteString>equals in class Objectobject - The object to be tested for equality with this attribute.true if object is an attribute which is equal to
this attribute, or false if not.ByteString firstValue()
NoSuchElementException - If this attribute is empty.String firstValueAsString()
NoSuchElementException - If this attribute is empty.AttributeDescription getAttributeDescription()
String getAttributeDescriptionAsString()
int hashCode()
hashCode in interface Collection<ByteString>hashCode in interface Set<ByteString>hashCode in class Objectboolean isEmpty()
true if this attribute contains no attribute values.isEmpty in interface Collection<ByteString>isEmpty in interface Set<ByteString>true if this attribute contains no attribute values.Iterator<ByteString> iterator()
iterator in interface Collection<ByteString>iterator in interface Iterable<ByteString>iterator in interface Set<ByteString>AttributeParser parse()
boolean remove(Object value)
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.valueOf(Object) method.
remove in interface Collection<ByteString>remove in interface Set<ByteString>value - The attribute value to be removed from this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support removal of attribute
values.NullPointerException - If value was null.boolean removeAll(Collection<?> values)
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.valueOf(Object) method.
An invocation of this method is equivalent to:
attribute.removeAll(values, null);
removeAll in interface Collection<ByteString>removeAll in interface Set<ByteString>values - The attribute values to be removed from this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support removal of attribute
values.NullPointerException - If values was null.<T> boolean removeAll(Collection<T> values, Collection<? super T> missingValues)
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.valueOf(Object) method.
T - The type of the attribute value objects being removed.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.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support removal of attribute
values.NullPointerException - If values was null.boolean retainAll(Collection<?> values)
values (optional operation).
Any attribute values which are not instances of ByteString will
be converted using the ByteString.valueOf(Object) method.
An invocation of this method is equivalent to:
attribute.retainAll(values, null);
retainAll in interface Collection<ByteString>retainAll in interface Set<ByteString>values - The attribute values to be retained in this attribute.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support removal of attribute
values.NullPointerException - If values was null.<T> boolean retainAll(Collection<T> values, Collection<? super T> missingValues)
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.valueOf(Object) method.
T - The type of the attribute value objects being retained.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.true if this attribute changed as a result of this call.UnsupportedOperationException - If this attribute does not support removal of attribute
values.NullPointerException - If values was null.int size()
size in interface Collection<ByteString>size in interface Set<ByteString>ByteString[] toArray()
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.
toArray in interface Collection<ByteString>toArray in interface Set<ByteString><T> T[] toArray(T[] array)
If the set fits in the specified array, it is returned therein.
Otherwise, a new array is allocated with the runtime type of the
specified array and the size of this attribute. If this attribute fits in
the specified array with room to spare (i.e., the array has more elements
than this attribute), the elements in the array immediately following the
end of the set is set to null.
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.
toArray in interface Collection<ByteString>toArray in interface Set<ByteString>T - The type of elements contained in array.array - An array into which the elements of this attribute should be
put.ArrayStoreException - If the runtime type of array is not a supertype of
ByteString.NullPointerException - If array was null.Copyright © 2011-2015 ForgeRock AS. All Rights Reserved.