Attribute (Gluu-OpenDJ 3.0.0.1.gluu-SNAPSHOT Documentation)

All Superinterfaces:

Iterable<org.forgerock.opendj.ldap.ByteString>

All Known Implementing Classes:

AbstractAttribute, CollectiveVirtualAttribute, VirtualAttribute
```
@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public interface Attribute
extends Iterable<org.forgerock.opendj.ldap.ByteString>
```
This class defines a data structure for storing and interacting with an attribute that may be used in the Directory Server.
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.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Attribute.RemoveOnceSwitchingAttributes` Marks code that can be removed once we are switching from server's to SDK's `Attribute`.

Method Summary

Methods
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<?> 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.
`org.forgerock.opendj.ldap.AttributeDescription`	`getAttributeDescription()` Retrieves the attribute description 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.
`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.
`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.
`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.

- Method Detail
  - approximatelyEqualTo
```
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.
    
    Parameters:
    assertionValue - The assertion value for which to make the determination.
    
    Returns:
    ConditionResult.UNDEFINED if this attribute does not have an approximate matching rule, ConditionResult.TRUE if at least one value is approximately equal to the provided value, or ConditionResult.FALSE otherwise.
  - contains
```
boolean contains(org.forgerock.opendj.ldap.ByteString value)
```
    Indicates whether this attribute contains the specified value.
    
    Parameters:
    value - The value for which to make the determination.
    
    Returns:
    true if this attribute has the specified value, or false if not.
  - containsAll
```
boolean containsAll(Collection<?> values)
```
    Indicates whether this attribute contains all the values in the collection.
    
    Parameters:
    values - The set of values for which to make the determination.
    
    Returns:
    true if this attribute contains all the values in the provided collection, or false if it does not contain at least one of them.
  - matchesEqualityAssertion
```
org.forgerock.opendj.ldap.ConditionResult matchesEqualityAssertion(org.forgerock.opendj.ldap.ByteString assertionValue)
```
    Indicates whether this attribute matches the specified assertion value.
    
    Parameters:
    assertionValue - The assertion value for which to make the determination.
    
    Returns:
    true if this attribute matches the specified assertion value, or false if not.
  - equals
```
boolean equals(Object o)
```
    Indicates whether the provided object is an attribute that is equal to this attribute. It will be considered equal if the attribute type, set of values, and set of options are equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - The object for which to make the determination.
    
    Returns:
    true if the provided object is an attribute that is equal to this attribute, or false if not.
  - getAttributeDescription
```
org.forgerock.opendj.ldap.AttributeDescription getAttributeDescription()
```
    Retrieves the attribute description for this attribute.
    
    Returns:
    The attribute description for this attribute.
  - getName
```
String getName()
```
    Retrieves the user-provided name for this attribute.
    
    Returns:
    The user-provided name for this attribute.
  - getNameWithOptions
```
String getNameWithOptions()
```
    Retrieves the user-provided name of this attribute, along with any options that might have been provided.
    
    Returns:
    The user-provided name of this attribute, along with any options that might have been provided.
  - greaterThanOrEqualTo
```
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.
    
    Parameters:
    assertionValue - The assertion value for which to make the determination.
    
    Returns:
    ConditionResult.UNDEFINED if this attribute does not have an ordering matching rule, ConditionResult.TRUE if at least one value is greater than or equal to the provided assertion value, or ConditionResult.FALSE otherwise.
  - hashCode
```
int hashCode()
```
    Retrieves the hash code for this attribute. It will be calculated as the sum of the hash code for the attribute type and all values.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    The hash code for this attribute.
  - hasOption
```
boolean hasOption(String option)
```
    Indicates whether this attribute has the specified option.
    
    Parameters:
    option - The option for which to make the determination.
    
    Returns:
    true if this attribute has the specified option, or false if not.
  - hasOptions
```
boolean hasOptions()
```
    Indicates whether this attribute has any options at all.
    
    Returns:
    true if this attribute has at least one option, or false if not.
  - isEmpty
```
boolean isEmpty()
```
    Returns true if this attribute contains no attribute values.
    
    Returns:
    true if this attribute contains no attribute values.
  - isReal
```
boolean isReal()
```
    Indicates whether this is a real attribute (persisted) rather than a virtual attribute (dynamically computed).
    
    Returns:
    true if this is a real attribute.
  - isVirtual
```
boolean isVirtual()
```
    Indicates whether this is a virtual attribute (dynamically computed) rather than a real attribute (persisted).
    
    Returns:
    true if this is a virtual attribute.
  - iterator
```
Iterator<org.forgerock.opendj.ldap.ByteString> iterator()
```
    Returns an iterator over the attribute values in this attribute. The attribute values are returned in the order in which they were added this attribute. The returned iterator does not support attribute value removals via Iterator.remove().
    
    Specified by:
    
    iterator in interface Iterable<org.forgerock.opendj.ldap.ByteString>
    
    Returns:
    An iterator over the attribute values in this attribute.
  - lessThanOrEqualTo
```
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.
    
    Parameters:
    assertionValue - The assertion value for which to make the determination.
    
    Returns:
    ConditionResult.UNDEFINED if this attribute does not have an ordering matching rule, ConditionResult.TRUE if at least one value is less than or equal to the provided assertion value, or ConditionResult.FALSE otherwise.
  - matchesSubstring
```
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.
    
    Parameters:
    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.
    
    Returns:
    ConditionResult.UNDEFINED if this attribute does not have a substring matching rule, ConditionResult.TRUE if at least one value matches the provided substring, or ConditionResult.FALSE otherwise.
  - size
```
int size()
```
    Returns the number of attribute values in this attribute.
    
    Returns:
    The number of attribute values in this attribute.
  - toString
```
String toString()
```
    Retrieves a one-line string representation of this attribute.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A one-line string representation of this attribute.
  - toString
```
void toString(StringBuilder buffer)
```
    Appends a one-line string representation of this attribute to the provided buffer.
    
    Parameters:
    buffer - The buffer to which the information should be appended.

Interface Attribute

Nested Class Summary

Method Summary

Method Detail

approximatelyEqualTo

contains

containsAll

matchesEqualityAssertion

equals

getAttributeDescription

getName

getNameWithOptions

greaterThanOrEqualTo

hashCode

hasOption

hasOptions

isEmpty

isReal

isVirtual

iterator

lessThanOrEqualTo

matchesSubstring

size

toString

toString