View Javadoc

1   /*
2    * Copyright 2010 The Apache Software Foundation
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  
21  package org.apache.hadoop.hbase.filter;
22  
23  import org.apache.hadoop.hbase.util.Bytes;
24  
25  /**
26   * A binary comparator which lexicographically compares against the specified
27   * byte array using {@link org.apache.hadoop.hbase.util.Bytes#compareTo(byte[], byte[])}.
28   */
29  public class BinaryComparator extends WritableByteArrayComparable {
30  
31    /** Nullary constructor for Writable, do not use */
32    public BinaryComparator() { }
33  
34    /**
35     * Constructor
36     * @param value value
37     */
38    public BinaryComparator(byte[] value) {
39      super(value);
40    }
41  
42    @Override
43    public int compareTo(byte [] value, int offset, int length) {
44      return Bytes.compareTo(this.value, 0, this.value.length, value, offset, length);
45    }
46  }