org.neo4j.values.TernaryComparator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-values Show documentation

Neo4j property value system.

There is a newer version: 5.26.0

/*
 * Copyright (c) 2002-2019 "Neo4j,"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.values;

/**
 * Comparator that allows undefined comparison.
 */
@FunctionalInterface
public interface TernaryComparator
{
    /**
     * Should return a negative integer if o1 is smaller than o2,
     * a positive integer if o1 is bigger than o2,
     * 0 if o1 and o2 are equal, and
     * {@code null} if they are not comparable.
     */
    Comparison ternaryCompare( T o1, T o2 );
}