org.opends.server.types

Class AttributeDescription

java.lang.Object

org.opends.server.types.AttributeDescription

All Implemented Interfaces:

Comparable<AttributeDescription>

public final class AttributeDescription
extends Object
implements Comparable<AttributeDescription>

Temporary class until we move to AttributeDescription.

Method Summary

Methods

Modifier and Type	Method and Description
static int	compare(AttributeType attrType1, Set<String> options1, AttributeType attrType2, Set<String> options2) Compares the first attribute type and options to the second attribute type and options, as if they were both instances of AttributeDescription.
int	compareTo(AttributeDescription other)
static boolean	containsAllOptions(Collection<String> options1, Collection<String> options2) Indicates whether the provided first set of not normalized options contains all values from the second set of not normalized options.
static boolean	containsOption(Set<String> options, String optionToFind) Indicates whether the provided set of not normalized options contains the provided option.
static AttributeDescription	create(Attribute attr) Creates an attribute description with the attribute type and options of the provided Attribute.
static AttributeDescription	create(AttributeType attributeType, Set<String> options) Creates an attribute description having the provided attribute type and options.
boolean	equals(Object obj)
AttributeType	getAttributeType() Returns the attribute type associated with this attribute description.
Set<String>	getOptions() Returns the set of not normalized options contained in this attribute description.
int	hashCode()
static boolean	optionsEqual(Set<String> options1, Set<String> options2) Indicates whether the provided first set of not normalized options equals the second set of not normalized options.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static AttributeDescription create(Attribute attr)

Creates an attribute description with the attribute type and options of the provided Attribute.

Parameters:

attr - The attribute.

Returns:

The attribute description.

Throws:

NullPointerException - If attributeType or options was null.

create

public static AttributeDescription create(AttributeType attributeType,
                          Set<String> options)

Creates an attribute description having the provided attribute type and options.

Parameters:

attributeType - The attribute type.

options - The attribute options.

Returns:

The attribute description.

Throws:

NullPointerException - If attributeType or options was null.

getAttributeType

public AttributeType getAttributeType()

Returns the attribute type associated with this attribute description.

Returns:

The attribute type associated with this attribute description.

getOptions

public Set<String> getOptions()

Returns the set of not normalized options contained in this attribute description.

Returns:

A set containing the not normalized options.

containsOption

public static boolean containsOption(Set<String> options,
                     String optionToFind)

Indicates whether the provided set of not normalized options contains the provided option.

Parameters:

options - The set of not normalized options where to do the search.

optionToFind - The option for which to make the determination.

Returns:

true if the provided set of options has the provided option, or false if not.

containsAllOptions

public static boolean containsAllOptions(Collection<String> options1,
                         Collection<String> options2)

Indicates whether the provided first set of not normalized options contains all values from the second set of not normalized options.

Parameters:

options1 - The first set of not normalized options where to do the search.

options2 - The second set of not normalized options that must all be found.

Returns:

true if the first provided set of options has all the options from the second provided set of options.

optionsEqual

public static boolean optionsEqual(Set<String> options1,
                   Set<String> options2)

Indicates whether the provided first set of not normalized options equals the second set of not normalized options.

Parameters:

options1 - The first set of not normalized options.

options2 - The second set of not normalized options.

Returns:

true if the first provided set of options equals the second provided set of options.

compareTo

public int compareTo(AttributeDescription other)

Specified by:

compareTo in interface Comparable<AttributeDescription>

compare

public static int compare(AttributeType attrType1,
          Set<String> options1,
          AttributeType attrType2,
          Set<String> options2)

Compares the first attribute type and options to the second attribute type and options, as if they were both instances of AttributeDescription.

The attribute types are compared first and then, if equal, the options are normalized, sorted, and compared.

Parameters:

attrType1 - The first attribute type to be compared.

options1 - The first options to be compared.

attrType2 - The second attribute type to be compared.

options2 - The second options to be compared.

Returns:

A negative integer, zero, or a positive integer as this attribute description is less than, equal to, or greater than the specified attribute description.

Throws:

NullPointerException - If name was null.

See Also:

compareTo(AttributeDescription)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object