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 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
32 */
33 public abstract class LdapComparator<T> extends LoadableSchemaObject implements Comparator<T>, Serializable
34 {
35 /** The serial version UID */
36 private static final long serialVersionUID = 2L;
37
38
39 /**
40 * Create a new instance of a Comparator
41 * @param oid The associated OID
42 */
43 protected LdapComparator( String oid )
44 {
45 super( SchemaObjectType.COMPARATOR, oid );
46 }
47
48
49 /**
50 * Store the SchemaManager in this instance. It may be necessary for some
51 * comparator which needs to have access to the oidNormalizer Map.
52 *
53 * @param schemaManager the schemaManager to store
54 */
55 public void setSchemaManager( SchemaManager schemaManager )
56 {
57 // Do nothing (general case).
58 }
59
60
61 /**
62 * {@inheritDoc}
63 */
64 @Override
65 public boolean equals( Object o )
66 {
67 if ( !super.equals( o ) )
68 {
69 return false;
70 }
71
72 return o instanceof LdapComparator<?>;
73 }
74
75
76 /**
77 * {@inheritDoc}
78 */
79 @Override
80 public String toString()
81 {
82 return objectType + " " + DescriptionUtils.getDescription( this );
83 }
84 }