org.opends.server.types

Class AbstractAttribute

java.lang.Object

org.opends.server.types.AbstractAttribute

All Implemented Interfaces:

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

Direct Known Subclasses:

CollectiveVirtualAttribute, VirtualAttribute

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public abstract class AbstractAttribute
extends Object
implements Attribute

An abstract base class for implementing new types of Attribute.

Nested Class Summary

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

Attribute.RemoveOnceSwitchingAttributes

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAttribute() Creates a new abstract attribute.

Method Summary

Methods

Modifier and Type	Method and Description
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.
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.
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).
String	toString() Retrieves a one-line string representation of this attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opends.server.types.Attribute

approximatelyEqualTo, contains, getAttributeDescription, greaterThanOrEqualTo, isVirtual, iterator, lessThanOrEqualTo, matchesEqualityAssertion, matchesSubstring, size, toString

Constructor Detail

AbstractAttribute

protected AbstractAttribute()

Creates a new abstract attribute.

Method Detail

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

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.

equals

public final boolean equals(Object o)

Description copied from interface: Attribute

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.

Specified by:

equals in interface Attribute

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.

getName

public String getName()

Retrieves the user-provided name for this attribute.

This implementation returns the primary name associated with this attribute's attribute type or, if there is no primary name, the attribute type's OID.

Specified by:

getName in interface Attribute

Returns:

The user-provided name for this attribute.

getNameWithOptions

public String getNameWithOptions()

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

Returns:

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

hashCode

public int hashCode()

Description copied from interface: Attribute

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.

Specified by:

hashCode in interface Attribute

Overrides:

hashCode in class Object

Returns:

The hash code for this attribute.

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

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

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

Returns:

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

isEmpty

public boolean isEmpty()

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

Returns:

true if this attribute contains no attribute values.

isReal

public boolean isReal()

Description copied from interface: Attribute

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

Specified by:

isReal in interface Attribute

Returns:

true if this is a real attribute.

toString

public final String toString()

Description copied from interface: Attribute

Retrieves a one-line string representation of this attribute.

Specified by:

toString in interface Attribute

Overrides:

toString in class Object

Returns:

A one-line string representation of this attribute.