org.opends.server.types

Class VirtualAttribute

java.lang.Object

org.opends.server.types.AbstractAttribute

org.opends.server.types.VirtualAttribute

All Implemented Interfaces:

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

@PublicAPI(stability=VOLATILE,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public final class VirtualAttribute
extends AbstractAttribute

This class defines a virtual attribute, which is a special kind of attribute whose values do not actually exist in persistent storage but rather are computed or otherwise obtained dynamically.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opends.server.types.Attribute

Attribute.RemoveOnceSwitchingAttributes

Constructor Summary

Constructors

Constructor and Description
VirtualAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType, Entry entry, VirtualAttributeRule rule) Creates a new virtual attribute with the provided information.

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.
org.forgerock.opendj.ldap.AttributeDescription	getAttributeDescription() Retrieves the attribute description for this attribute.
String	getNameWithOptions() Retrieves the user-provided name of this attribute, along with any options that might have been provided.
VirtualAttributeRule	getVirtualAttributeRule() Retrieves the virtual attribute rule that governs the behavior of this virtual 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	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	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.
void	toString(StringBuilder buffer) Appends a one-line string representation of this attribute to the provided buffer.

Methods inherited from class org.opends.server.types.AbstractAttribute

equals, getName, hashCode, isReal, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

VirtualAttribute

public VirtualAttribute(org.forgerock.opendj.ldap.schema.AttributeType attributeType,
                Entry entry,
                VirtualAttributeRule rule)

Creates a new virtual attribute with the provided information.

Parameters:

attributeType - The attribute type for this virtual attribute.

entry - The entry in which this virtual attribute exists.

rule - The virtual attribute rule that governs the behavior of this virtual attribute.

Method Detail

approximatelyEqualTo

public org.forgerock.opendj.ldap.ConditionResult approximatelyEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)

Description copied from interface: Attribute

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

public boolean contains(org.forgerock.opendj.ldap.ByteString value)

Description copied from interface: Attribute

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

public boolean containsAll(Collection<?> values)

Description copied from interface: Attribute

Indicates whether this attribute contains all the values in the collection.

Specified by:

containsAll in interface Attribute

Overrides:

containsAll in class AbstractAttribute

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

public org.forgerock.opendj.ldap.ConditionResult matchesEqualityAssertion(org.forgerock.opendj.ldap.ByteString assertionValue)

Description copied from interface: Attribute

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.

getNameWithOptions

public String getNameWithOptions()

Description copied from class: AbstractAttribute

Retrieves the user-provided name of this attribute, along with any options that might have been provided.

This implementation returns this attribute's name if there are no attribute options, otherwise it constructs a string comprising of this attribute's name followed by a semi-colon and a semi-colon separated list of its attribute options.

Specified by:

getNameWithOptions in interface Attribute

Overrides:

getNameWithOptions in class AbstractAttribute

Returns:

The user-provided name of this attribute, along with any options that might have been provided.

getAttributeDescription

public org.forgerock.opendj.ldap.AttributeDescription getAttributeDescription()

Description copied from interface: Attribute

Retrieves the attribute description for this attribute.

Returns:

The attribute description for this attribute.

getVirtualAttributeRule

public VirtualAttributeRule getVirtualAttributeRule()

Retrieves the virtual attribute rule that governs the behavior of this virtual attribute.

Returns:

The virtual attribute rule that governs the behavior of this virtual attribute.

greaterThanOrEqualTo

public org.forgerock.opendj.ldap.ConditionResult greaterThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)

Description copied from interface: Attribute

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.

hasOption

public boolean hasOption(String option)

Description copied from interface: Attribute

Indicates whether this attribute has the specified option.

Specified by:

hasOption in interface Attribute

Overrides:

hasOption in class AbstractAttribute

Parameters:

option - The option for which to make the determination.

Returns:

true if this attribute has the specified option, or false if not.

hasOptions

public boolean hasOptions()

Description copied from class: AbstractAttribute

Indicates whether this attribute has any options at all.

This implementation retrieves the set of options associated with this attribute and tests to see if it is empty.

Specified by:

hasOptions in interface Attribute

Overrides:

hasOptions in class AbstractAttribute

Returns:

true if this attribute has at least one option, or false if not.

isEmpty

public boolean isEmpty()

Description copied from class: AbstractAttribute

Returns true if this attribute contains no attribute values.

This implementation returns true if the Attribute.size() of this attribute is zero.

Specified by:

isEmpty in interface Attribute

Overrides:

isEmpty in class AbstractAttribute

Returns:

true if this attribute contains no attribute values.

isVirtual

public boolean isVirtual()

Description copied from interface: Attribute

Indicates whether this is a virtual attribute (dynamically computed) rather than a real attribute (persisted).

Returns:

true if this is a virtual attribute.

iterator

public Iterator<org.forgerock.opendj.ldap.ByteString> iterator()

Description copied from interface: Attribute

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().

Returns:

An iterator over the attribute values in this attribute.

lessThanOrEqualTo

public org.forgerock.opendj.ldap.ConditionResult lessThanOrEqualTo(org.forgerock.opendj.ldap.ByteString assertionValue)

Description copied from interface: Attribute

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

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

Description copied from interface: Attribute

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

public int size()

Description copied from interface: Attribute

Returns the number of attribute values in this attribute.

Returns:

The number of attribute values in this attribute.

toString

public void toString(StringBuilder buffer)

Description copied from interface: Attribute

Appends a one-line string representation of this attribute to the provided buffer.

Parameters:

buffer - The buffer to which the information should be appended.