001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *  
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *  
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License. 
018 *  
019 */
020package org.apache.directory.shared.ldap.model.schema;
021
022
023import java.io.Serializable;
024import java.util.Comparator;
025
026
027/**
028 * An class used for Comparator. It inherits from the general AbstractAdsSchemaObject class. It
029 * also implements the Comparator interface
030 * 
031 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
032 */
033public abstract class LdapComparator<T> extends LoadableSchemaObject implements Comparator<T>, Serializable
034{
035    /** The serial version UID */
036    private static final long serialVersionUID = 2L;
037
038    /**
039     * Create a new instance of a Comparator
040     * @param oid The associated OID
041     */
042    protected LdapComparator( String oid )
043    {
044        super( SchemaObjectType.COMPARATOR, oid );
045    }
046
047
048    /**
049     * Store the SchemaManager in this instance. It may be necessary for some
050     * comparator which needs to have access to the oidNormalizer Map.
051     *
052     * @param schemaManager the schemaManager to store
053     */
054    public void setSchemaManager( SchemaManager schemaManager )
055    {
056        // Do nothing (general case).
057    }
058
059
060    /**
061     * {@inheritDoc}
062     */
063    @Override
064    public boolean equals( Object o )
065    {
066        if ( !super.equals( o ) )
067        {
068            return false;
069        }
070
071        return o instanceof LdapComparator<?>;
072    }
073
074
075    /**
076     * {@inheritDoc}
077     */
078    @Override
079    public String toString()
080    {
081        return objectType + " " + DescriptionUtils.getDescription( this );
082    }
083}