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.mavibot.btree.comparator;
021
022
023import java.util.Comparator;
024
025
026/**
027 * Compares booleans
028 *
029 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
030 */
031public class BooleanComparator implements Comparator<Boolean>
032{
033    /** A static instance of a BooleanComparator */
034    public static final BooleanComparator INSTANCE = new BooleanComparator();
035
036    /**
037     * A private constructor of the BooleanComparator class
038     */
039    private BooleanComparator()
040    {
041    }
042
043
044    /**
045     * Compare two booleans.
046     *
047     * @param boolean1 First boolean
048     * @param boolean2 Second boolean
049     * @return 1 if boolean1 > boolean2, 0 if boolean1 == boolean2, -1 if boolean1 < boolean2
050     */
051    public int compare( Boolean boolean1, Boolean boolean2 )
052    {
053        if ( boolean1 == boolean2 )
054        {
055            return 0;
056        }
057
058        if ( boolean1 == null )
059        {
060            return -1;
061        }
062
063        if ( boolean2 == null )
064        {
065            return 1;
066        }
067
068        return boolean1.compareTo( boolean2 );
069    }
070}