org.apache.directory.api.ldap.model.schema

Class AttributeTypeOptions

java.lang.Object

org.apache.directory.api.ldap.model.schema.AttributeTypeOptions

public class AttributeTypeOptions
extends java.lang.Object

An structure containing a couple of attributeType and options. A search request can contain a list of attribute to return, those attribute could be associated with options. Those options are stored into a Set.

Field Summary

Fields

Modifier and Type	Field and Description
private AttributeType	attributeType The attributeType
private java.util.Set<java.lang.String>	options The options, if any

Constructor Summary

Constructors

Constructor and Description
AttributeTypeOptions(AttributeType attributeType) Creates a new instance of AttributeTypeOptions, containing an attributeType, but no options.
AttributeTypeOptions(AttributeType attributeType, java.util.Set<java.lang.String> options) Creates a new instance of AttributeTypeOptions, containing an attributeType, and options.

Method Summary

Modifier and Type	Method and Description
void	addOption(java.lang.String option) Add a new option to the option set for this attributeType.
void	addOptions(java.util.Set<java.lang.String> optionsToAdd) Add a set of optionS to the option set for this attributeType.
boolean	equals(java.lang.Object o)
AttributeType	getAttributeType()
java.util.Set<java.lang.String>	getOptions()
int	hashCode()
boolean	hasOption()
boolean	hasOption(java.lang.String option)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

attributeType

private AttributeType attributeType

The attributeType

options

private java.util.Set<java.lang.String> options

The options, if any

Constructor Detail

AttributeTypeOptions

public AttributeTypeOptions(AttributeType attributeType)

Creates a new instance of AttributeTypeOptions, containing an attributeType, but no options.

Parameters:

attributeType - The associated AttributeType

AttributeTypeOptions

public AttributeTypeOptions(AttributeType attributeType,
                            java.util.Set<java.lang.String> options)

Creates a new instance of AttributeTypeOptions, containing an attributeType, and options.

Parameters:

attributeType - the associated AttributeType

options - the associated options

Method Detail

getAttributeType

public AttributeType getAttributeType()

Returns:

the inner attributeType

getOptions

public java.util.Set<java.lang.String> getOptions()

Returns:

the associated options

hasOption

public boolean hasOption()

Returns:

true if the attributeType has at least one option

hasOption

public boolean hasOption(java.lang.String option)

Parameters:

option - the option to check

Returns:

true if the attributeType has the given option

addOption

public void addOption(java.lang.String option)

Add a new option to the option set for this attributeType.

Parameters:

option - the option to add

addOptions

public void addOptions(java.util.Set<java.lang.String> optionsToAdd)

Add a set of optionS to the option set for this attributeType.

Parameters:

optionsToAdd - the options to add

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

See Also:

Object.hashCode()

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(Object)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object