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.api.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 * @param <T> The comparator type 032 * 033 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 034 */ 035public abstract class LdapComparator<T> extends LoadableSchemaObject implements Comparator<T>, Serializable 036{ 037 /** The serial version UID */ 038 private static final long serialVersionUID = 2L; 039 040 041 /** 042 * Create a new instance of a Comparator 043 * @param oid The associated OID 044 */ 045 protected LdapComparator( String oid ) 046 { 047 super( SchemaObjectType.COMPARATOR, oid ); 048 } 049 050 051 /** 052 * Store the SchemaManager in this instance. It may be necessary for some 053 * comparator which needs to have access to the oidNormalizer Map. 054 * 055 * @param schemaManager the schemaManager to store 056 */ 057 public void setSchemaManager( SchemaManager schemaManager ) 058 { 059 // Do nothing (general case). 060 } 061 062 063 /** 064 * {@inheritDoc} 065 */ 066 @Override 067 public boolean equals( Object o ) 068 { 069 if ( !super.equals( o ) ) 070 { 071 return false; 072 } 073 074 return o instanceof LdapComparator<?>; 075 } 076 077 078 /** 079 * {@inheritDoc} 080 */ 081 @Override 082 public String toString() 083 { 084 return objectType + " " + DescriptionUtils.getDescription( this ); 085 } 086}