@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public interface Attribute extends Iterable<org.forgerock.opendj.ldap.ByteString>
Attributes are immutable and therefore any attempts to modify them
will result in an UnsupportedOperationException
.
There are two types of attribute: real attributes and virtual attributes.
Real attributes can be created using the AttributeBuilder
class
or by using the various static factory methods in the Attributes
class,
whereas virtual attributes are represented using the VirtualAttribute
class.
New attribute implementations can be implemented by either implementing this interface
or by extending AbstractAttribute
.
Modifier and Type | Method and Description |
---|---|
org.forgerock.opendj.ldap.ConditionResult |
approximatelyEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
Indicates whether this attribute has any value(s) that are
approximately equal to the provided value.
|
boolean |
contains(org.forgerock.opendj.ldap.ByteString value)
Indicates whether this attribute contains the specified value.
|
boolean |
containsAll(Collection<org.forgerock.opendj.ldap.ByteString> values)
Indicates whether this attribute contains all the values in the
collection.
|
boolean |
equals(Object o)
Indicates whether the provided object is an attribute that is
equal to this attribute.
|
AttributeType |
getAttributeType()
Retrieves the attribute type for this attribute.
|
String |
getName()
Retrieves the user-provided name for this attribute.
|
String |
getNameWithOptions()
Retrieves the user-provided name of this attribute, along with
any options that might have been provided.
|
Set<String> |
getOptions()
Retrieves the unmodifiable set of attribute options for this
attribute.
|
org.forgerock.opendj.ldap.ConditionResult |
greaterThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
Indicates whether this attribute has any value(s) that are
greater than or equal to the provided value.
|
boolean |
hasAllOptions(Collection<String> options)
Indicates whether this attribute has all of the options in the
provided collection.
|
int |
hashCode()
Retrieves the hash code for this attribute.
|
boolean |
hasOption(String option)
Indicates whether this attribute has the specified option.
|
boolean |
hasOptions()
Indicates whether this attribute has any options at all.
|
boolean |
isEmpty()
Returns
true if this attribute contains no
attribute values. |
boolean |
isReal()
Indicates whether this is a real attribute (persisted) rather than a virtual attribute
(dynamically computed).
|
boolean |
isVirtual()
Indicates whether this is a virtual attribute (dynamically computed) rather than a real
attribute (persisted).
|
Iterator<org.forgerock.opendj.ldap.ByteString> |
iterator()
Returns an iterator over the attribute values in this attribute.
|
org.forgerock.opendj.ldap.ConditionResult |
lessThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
Indicates whether this attribute has any value(s) that are less
than or equal to the provided value.
|
org.forgerock.opendj.ldap.ConditionResult |
matchesEqualityAssertion(org.forgerock.opendj.ldap.ByteString assertionValue)
Indicates whether this attribute matches the specified assertion value.
|
org.forgerock.opendj.ldap.ConditionResult |
matchesSubstring(org.forgerock.opendj.ldap.ByteString subInitial,
List<org.forgerock.opendj.ldap.ByteString> subAny,
org.forgerock.opendj.ldap.ByteString subFinal)
Indicates whether this attribute has any value(s) that match the
provided substring.
|
boolean |
optionsEqual(Set<String> options)
Indicates whether this attribute has exactly the specified set of
options.
|
int |
size()
Returns the number of attribute values in this attribute.
|
String |
toString()
Retrieves a one-line string representation of this attribute.
|
void |
toString(StringBuilder buffer)
Appends a one-line string representation of this attribute to the
provided buffer.
|
org.forgerock.opendj.ldap.ConditionResult approximatelyEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
assertionValue
- The assertion value for which to make the determination.UNDEFINED
if this attribute does not have
an approximate matching rule, TRUE
if at
least one value is approximately equal to the provided
value, or false
otherwise.boolean contains(org.forgerock.opendj.ldap.ByteString value)
value
- The value for which to make the determination.true
if this attribute has the specified
value, or false
if not.boolean containsAll(Collection<org.forgerock.opendj.ldap.ByteString> values)
values
- The set of values for which to make the determination.true
if this attribute contains all the
values in the provided collection, or false
if it does not contain at least one of them.org.forgerock.opendj.ldap.ConditionResult matchesEqualityAssertion(org.forgerock.opendj.ldap.ByteString assertionValue)
assertionValue
- The assertion value for which to make the determination.true
if this attribute matches the specified assertion
value, or false
if not.boolean equals(Object o)
AttributeType getAttributeType()
String getName()
String getNameWithOptions()
Set<String> getOptions()
org.forgerock.opendj.ldap.ConditionResult greaterThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
assertionValue
- The assertion value for which to make the determination.UNDEFINED
if this attribute does not have
an ordering matching rule, TRUE
if at
least one value is greater than or equal to the provided
assertion value, or false
otherwise.boolean hasAllOptions(Collection<String> options)
options
- The collection of options for which to make the
determination (may be null
).true
if this attribute has all of the
specified options, or false
if it does not
have at least one of them.int hashCode()
boolean hasOption(String option)
option
- The option for which to make the determination.true
if this attribute has the specified
option, or false
if not.boolean hasOptions()
true
if this attribute has at least one
option, or false
if not.boolean isEmpty()
true
if this attribute contains no
attribute values.true
if this attribute contains no
attribute values.boolean isReal()
true
if this is a real attribute.boolean isVirtual()
true
if this is a virtual attribute.Iterator<org.forgerock.opendj.ldap.ByteString> iterator()
remove
method.org.forgerock.opendj.ldap.ConditionResult lessThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)
assertionValue
- The assertion value for which to make the determination.UNDEFINED
if this attribute does not have
an ordering matching rule, TRUE
if at
least one value is less than or equal to the provided
assertion value, or false
otherwise.org.forgerock.opendj.ldap.ConditionResult matchesSubstring(org.forgerock.opendj.ldap.ByteString subInitial, List<org.forgerock.opendj.ldap.ByteString> subAny, org.forgerock.opendj.ldap.ByteString subFinal)
subInitial
- The subInitial component to use in the determination.subAny
- The subAny components to use in the determination.subFinal
- The subFinal component to use in the determination.UNDEFINED
if this attribute does not have
a substring matching rule, TRUE
if at
least one value matches the provided substring, or
FALSE
otherwise.boolean optionsEqual(Set<String> options)
options
- The set of options for which to make the determination
(may be null
).true
if this attribute has exactly the
specified set of options.int size()
void toString(StringBuilder buffer)
buffer
- The buffer to which the information should be appended.Copyright © 2010-2015 ForgeRock AS. All Rights Reserved.