org.apache.directory.shared.ldap.schema.registries
Interface ComparatorRegistry

All Superinterfaces:
java.lang.Iterable<LdapComparator<?>>, SchemaObjectRegistry<LdapComparator<?>>
All Known Implementing Classes:
DefaultComparatorRegistry, ImmutableComparatorRegistry

public interface ComparatorRegistry
extends SchemaObjectRegistry<LdapComparator<?>>, java.lang.Iterable<LdapComparator<?>>

Comparator registry component's service class.

Version:
$Rev: 923524 $
Author:
Apache Directory Project

Method Summary
 ComparatorRegistry copy()
          Copy the ComparatorRegistry
 void register(LdapComparator<?> comparator)
          Registers a new LdapComparator with this registry.
 LdapComparator<?> unregister(java.lang.String numericOid)
          Removes the LdapComparator registered with this registry, using its numeric OID.
 void unregisterSchemaElements(java.lang.String schemaName)
          Unregisters all LdapComparators defined for a specific schema from this registry.
 
Methods inherited from interface org.apache.directory.shared.ldap.schema.registries.SchemaObjectRegistry
clear, contains, get, getOidByName, getSchemaName, getType, iterator, lookup, oidsIterator, renameSchema, size, unregister
 
Methods inherited from interface java.lang.Iterable
iterator
 

Method Detail

register

void register(LdapComparator<?> comparator)
              throws LdapException
Registers a new LdapComparator with this registry.

Specified by:
register in interface SchemaObjectRegistry<LdapComparator<?>>
Parameters:
comparator - the LdapComparator to register
Throws:
LdapException - if the LdapComparator is already registered or the registration operation is not supported

unregister

LdapComparator<?> unregister(java.lang.String numericOid)
                             throws LdapException
Removes the LdapComparator registered with this registry, using its numeric OID.

Specified by:
unregister in interface SchemaObjectRegistry<LdapComparator<?>>
Parameters:
numericOid - the numeric identifier
Throws:
LdapException - if the numeric identifier is invalid

unregisterSchemaElements

void unregisterSchemaElements(java.lang.String schemaName)
                              throws LdapException
Unregisters all LdapComparators defined for a specific schema from this registry.

Specified by:
unregisterSchemaElements in interface SchemaObjectRegistry<LdapComparator<?>>
Parameters:
schemaName - the name of the schema whose LdapComparators will be removed from
Throws:
LdapException

copy

ComparatorRegistry copy()
Copy the ComparatorRegistry

Specified by:
copy in interface SchemaObjectRegistry<LdapComparator<?>>
Returns:
SchemaObjectRegistry The copied registry


Copyright © 2003-2011 Apache Software Foundation. All Rights Reserved.