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.comparators;
21  
22  
23  import java.io.Serializable;
24  
25  import org.apache.directory.api.i18n.I18n;
26  import org.apache.directory.api.ldap.model.schema.LdapComparator;
27  
28  
29  /**
30   * Compares Long keys and values within a table.
31   * 
32   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
33   */
34  public class LongComparator extends LdapComparator<Long> implements Serializable
35  {
36      /** The serial version UID */
37      private static final long serialVersionUID = 2L;
38  
39  
40      /**
41       * The LongComparator constructor. Its OID is the IntegerOrderingMatch matching
42       * rule OID.
43       */
44      public LongComparator( String oid )
45      {
46          super( oid );
47      }
48  
49  
50      /**
51       * Compare two objects.
52       * 
53       * @param obj1 First object
54       * @param obj2 Second object
55       * @return 1 if obj1 > obj2, 0 if obj1 == obj2, -1 if obj1 < obj2
56       */
57      @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "RC_REF_COMPARISON",
58          justification = "false positive")
59      public int compare( Long obj1, Long obj2 )
60      {
61          if ( obj1 == obj2 )
62          {
63              return 0;
64          }
65  
66          if ( obj1 == null )
67          {
68              throw new IllegalArgumentException( I18n.err( I18n.ERR_04219_ARGUMENT1_NULL ) );
69          }
70  
71          if ( obj2 == null )
72          {
73              throw new IllegalArgumentException( I18n.err( I18n.ERR_04220_ARGUMENT2_NULL ) );
74          }
75  
76          return obj1.compareTo( obj2 );
77      }
78  }