org.apache.flink.runtime.state.gemini.engine.page.bmap.GComparator Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.flink.runtime.state.gemini.engine.page.bmap;
import java.util.Comparator;
/**
* GComparator for Gemini.
*/
public interface GComparator {
/**
* Compares for order. Returns a negative integer,
* zero, or a positive integer as the first Key Object is less than, equal
* to, or greater than the second.
*
* @param left left Key's Binary Object
* @param right right Key's Binary Object
* @return An integer result of the comparison.
*/
int compare(BinaryKey left, BinaryKey right);
/**
* Compares for order. Returns a negative integer,
* zero, or a positive integer as the first Key Object is less than, equal
* to, or greater than the second.
*
* @param left left Key's Object
* @param right right Key's Object
* @return An integer result of the comparison.
*/
int compare(K left, K right);
/**
* Compares for order. Returns a negative integer,
* zero, or a positive integer as the first Key Object is less than, equal
* to, or greater than the second.
*
* @param left left Key's Object
* @param right right Key's Binary Object
* @return An integer result of the comparison.
*/
int compare(K left, BinaryKey right);
/**
* get JDK Comparator using in POJO Map.
*
* @return Comparator.
*/
Comparator getJDKCompactor();
Comparator getJDKBinaryCompactor();
}