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.comparators;
021
022
023import java.io.Serializable;
024
025import org.apache.directory.api.i18n.I18n;
026import org.apache.directory.api.ldap.model.schema.LdapComparator;
027
028
029/**
030 * Compares Long keys and values within a table.
031 * 
032 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
033 */
034public class LongComparator extends LdapComparator<Long> implements Serializable
035{
036    /** The serial version UID */
037    private static final long serialVersionUID = 2L;
038
039
040    /**
041     * The LongComparator constructor. Its OID is the IntegerOrderingMatch matching
042     * rule OID.
043     */
044    public LongComparator( String oid )
045    {
046        super( oid );
047    }
048
049
050    /**
051     * Compare two objects.
052     * 
053     * @param obj1 First object
054     * @param obj2 Second object
055     * @return 1 if obj1 > obj2, 0 if obj1 == obj2, -1 if obj1 < obj2
056     */
057    @edu.umd.cs.findbugs.annotations.SuppressWarnings(value = "RC_REF_COMPARISON",
058        justification = "false positive")
059    public int compare( Long obj1, Long obj2 )
060    {
061        if ( obj1 == obj2 )
062        {
063            return 0;
064        }
065
066        if ( obj1 == null )
067        {
068            throw new IllegalArgumentException( I18n.err( I18n.ERR_04219_ARGUMENT1_NULL ) );
069        }
070
071        if ( obj2 == null )
072        {
073            throw new IllegalArgumentException( I18n.err( I18n.ERR_04220_ARGUMENT2_NULL ) );
074        }
075
076        return obj1.compareTo( obj2 );
077    }
078}