unsafe/sort/RecordComparator.java

0001 /*
0002  * Licensed to the Apache Software Foundation (ASF) under one or more
0003  * contributor license agreements.  See the NOTICE file distributed with
0004  * this work for additional information regarding copyright ownership.
0005  * The ASF licenses this file to You under the Apache License, Version 2.0
0006  * (the "License"); you may not use this file except in compliance with
0007  * the License.  You may obtain a copy of the License at
0008  *
0009  *    http://www.apache.org/licenses/LICENSE-2.0
0010  *
0011  * Unless required by applicable law or agreed to in writing, software
0012  * distributed under the License is distributed on an "AS IS" BASIS,
0013  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0014  * See the License for the specific language governing permissions and
0015  * limitations under the License.
0016  */
0017
0018 package org.apache.spark.util.collection.unsafe.sort;
0019
0020 /**
0021  * Compares records for ordering. In cases where the entire sorting key can fit in the 8-byte
0022  * prefix, this may simply return 0.
0023  */
0024 public abstract class RecordComparator {
0025
0026   /**
0027    * Compare two records for order.
0028    *
0029    * @return a negative integer, zero, or a positive integer as the first record is less than,
0030    *         equal to, or greater than the second.
0031    */
0032   public abstract int compare(
0033     Object leftBaseObject,
0034     long leftBaseOffset,
0035     int leftBaseLength,
0036     Object rightBaseObject,
0037     long rightBaseOffset,
0038     int rightBaseLength);
0039 }