com.unboundid.directory.sdk.broker.types

Class StoreAttributeDefinition

java.lang.Object

com.unboundid.directory.sdk.broker.types.StoreAttributeDefinition

@NotExtensible
public final class StoreAttributeDefinition
extends java.lang.Object

An attribute in a Store Adapter's native schema. Use StoreAttributeDefinition.Builder to create instances of this class.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoreAttributeDefinition.Builder Builder class to build an instance of StoreAttributeDefinition.
static class	StoreAttributeDefinition.Type An enumeration of the data types for values.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getDescription() Gets the description of the attribute.
java.lang.String	getName() Gets the name of the attribute.
java.util.Collection<StoreAttributeDefinition>	getSubAttributes() Gets the sub-attributes for a complex attribute.
StoreAttributeDefinition.Type	getType() Gets the type of the value for this attribute.
int	hashCode()
boolean	isMultiValued() Determines if the attribute allows multiple values.
java.lang.String	toString() Gets a string representation of the attribute.

Methods inherited from class java.lang.Object

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

Method Detail

isMultiValued

public boolean isMultiValued()

Determines if the attribute allows multiple values.

Returns:

true if the attribute is multivalued, or false if it is not.

getType

public StoreAttributeDefinition.Type getType()

Gets the type of the value for this attribute.

Returns:

type of the value for this attribute.

getName

public java.lang.String getName()

Gets the name of the attribute.

Returns:

the name of the attribute.

getDescription

public java.lang.String getDescription()

Gets the description of the attribute.

Returns:

the description of the attribute.

getSubAttributes

public java.util.Collection<StoreAttributeDefinition> getSubAttributes()

Gets the sub-attributes for a complex attribute.

Returns:

the sub-attributes for a complex attribute.

toString

public java.lang.String toString()

Gets a string representation of the attribute.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the attribute.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object