View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *  
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *  
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License. 
18   *  
19   */
20  package org.apache.directory.api.ldap.model.schema;
21  
22  
23  import java.io.Serializable;
24  import java.util.Comparator;
25  
26  
27  /**
28   * An class used for Comparator. It inherits from the general AbstractAdsSchemaObject class. It
29   * also implements the Comparator interface
30   * 
31   * @param <T> The comparator type
32   * 
33   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
34   */
35  public abstract class LdapComparator<T> extends LoadableSchemaObject implements Comparator<T>, Serializable
36  {
37      /** The serial version UID */
38      private static final long serialVersionUID = 2L;
39  
40  
41      /**
42       * Create a new instance of a Comparator
43       * @param oid The associated OID
44       */
45      protected LdapComparator( String oid )
46      {
47          super( SchemaObjectType.COMPARATOR, oid );
48      }
49  
50  
51      /**
52       * Store the SchemaManager in this instance. It may be necessary for some
53       * comparator which needs to have access to the oidNormalizer Map.
54       *
55       * @param schemaManager the schemaManager to store
56       */
57      public void setSchemaManager( SchemaManager schemaManager )
58      {
59          // Do nothing (general case).
60      }
61  
62  
63      /**
64       * {@inheritDoc}
65       */
66      @Override
67      public boolean equals( Object o )
68      {
69          if ( !super.equals( o ) )
70          {
71              return false;
72          }
73  
74          return o instanceof LdapComparator<?>;
75      }
76  
77  
78      /**
79       * {@inheritDoc}
80       */
81      @Override
82      public String toString()
83      {
84          return objectType + " " + DescriptionUtils.getDescription( this );
85      }
86  }