blob: 8c88831b81baaa9b88e457c0906e7b58d04a3aaf [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Source code</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="source: package: org.apache.hadoop.hbase.util, enum: Order">
<meta name="generator" content="javadoc/SourceToHTMLConverter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body class="source-page">
<main role="main">
<div class="source-container">
<pre><span class="source-line-no">001</span><span id="line-1">/*</span>
<span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span>
<span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span>
<span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span>
<span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span>
<span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span>
<span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span>
<span class="source-line-no">009</span><span id="line-9"> *</span>
<span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="source-line-no">011</span><span id="line-11"> *</span>
<span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span>
<span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span>
<span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
<span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span>
<span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span>
<span class="source-line-no">017</span><span id="line-17"> */</span>
<span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.util;</span>
<span class="source-line-no">019</span><span id="line-19"></span>
<span class="source-line-no">020</span><span id="line-20">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">/**</span>
<span class="source-line-no">023</span><span id="line-23"> * Used to describe or modify the lexicographical sort order of a {@code byte[]}. Default ordering</span>
<span class="source-line-no">024</span><span id="line-24"> * is considered {@code ASCENDING}. The order of a {@code byte[]} can be inverted, resulting in</span>
<span class="source-line-no">025</span><span id="line-25"> * {@code DESCENDING} order, by replacing each byte with its 1's compliment.</span>
<span class="source-line-no">026</span><span id="line-26"> */</span>
<span class="source-line-no">027</span><span id="line-27">@InterfaceAudience.Public</span>
<span class="source-line-no">028</span><span id="line-28">public enum Order {</span>
<span class="source-line-no">029</span><span id="line-29"> ASCENDING {</span>
<span class="source-line-no">030</span><span id="line-30"> @Override</span>
<span class="source-line-no">031</span><span id="line-31"> public int cmp(int cmp) {</span>
<span class="source-line-no">032</span><span id="line-32"> /* noop */ return cmp;</span>
<span class="source-line-no">033</span><span id="line-33"> }</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> @Override</span>
<span class="source-line-no">036</span><span id="line-36"> public byte apply(byte val) {</span>
<span class="source-line-no">037</span><span id="line-37"> /* noop */ return val;</span>
<span class="source-line-no">038</span><span id="line-38"> }</span>
<span class="source-line-no">039</span><span id="line-39"></span>
<span class="source-line-no">040</span><span id="line-40"> @Override</span>
<span class="source-line-no">041</span><span id="line-41"> public void apply(byte[] val) {</span>
<span class="source-line-no">042</span><span id="line-42"> /* noop */</span>
<span class="source-line-no">043</span><span id="line-43"> }</span>
<span class="source-line-no">044</span><span id="line-44"></span>
<span class="source-line-no">045</span><span id="line-45"> @Override</span>
<span class="source-line-no">046</span><span id="line-46"> public void apply(byte[] val, int offset, int length) {</span>
<span class="source-line-no">047</span><span id="line-47"> /* noop */</span>
<span class="source-line-no">048</span><span id="line-48"> }</span>
<span class="source-line-no">049</span><span id="line-49"></span>
<span class="source-line-no">050</span><span id="line-50"> @Override</span>
<span class="source-line-no">051</span><span id="line-51"> public String toString() {</span>
<span class="source-line-no">052</span><span id="line-52"> return "ASCENDING";</span>
<span class="source-line-no">053</span><span id="line-53"> }</span>
<span class="source-line-no">054</span><span id="line-54"> },</span>
<span class="source-line-no">055</span><span id="line-55"></span>
<span class="source-line-no">056</span><span id="line-56"> DESCENDING {</span>
<span class="source-line-no">057</span><span id="line-57"> /**</span>
<span class="source-line-no">058</span><span id="line-58"> * A {@code byte} value is inverted by taking its 1's Complement, achieved via {@code xor} with</span>
<span class="source-line-no">059</span><span id="line-59"> * {@code 0xff}.</span>
<span class="source-line-no">060</span><span id="line-60"> */</span>
<span class="source-line-no">061</span><span id="line-61"> private static final byte MASK = (byte) 0xff;</span>
<span class="source-line-no">062</span><span id="line-62"></span>
<span class="source-line-no">063</span><span id="line-63"> @Override</span>
<span class="source-line-no">064</span><span id="line-64"> public int cmp(int cmp) {</span>
<span class="source-line-no">065</span><span id="line-65"> return -1 * cmp;</span>
<span class="source-line-no">066</span><span id="line-66"> }</span>
<span class="source-line-no">067</span><span id="line-67"></span>
<span class="source-line-no">068</span><span id="line-68"> @Override</span>
<span class="source-line-no">069</span><span id="line-69"> public byte apply(byte val) {</span>
<span class="source-line-no">070</span><span id="line-70"> return (byte) (val ^ MASK);</span>
<span class="source-line-no">071</span><span id="line-71"> }</span>
<span class="source-line-no">072</span><span id="line-72"></span>
<span class="source-line-no">073</span><span id="line-73"> @Override</span>
<span class="source-line-no">074</span><span id="line-74"> public void apply(byte[] val) {</span>
<span class="source-line-no">075</span><span id="line-75"> for (int i = 0; i &lt; val.length; i++) {</span>
<span class="source-line-no">076</span><span id="line-76"> val[i] ^= MASK;</span>
<span class="source-line-no">077</span><span id="line-77"> }</span>
<span class="source-line-no">078</span><span id="line-78"> }</span>
<span class="source-line-no">079</span><span id="line-79"></span>
<span class="source-line-no">080</span><span id="line-80"> @Override</span>
<span class="source-line-no">081</span><span id="line-81"> public void apply(byte[] val, int offset, int length) {</span>
<span class="source-line-no">082</span><span id="line-82"> for (int i = 0; i &lt; length; i++) {</span>
<span class="source-line-no">083</span><span id="line-83"> val[offset + i] ^= MASK;</span>
<span class="source-line-no">084</span><span id="line-84"> }</span>
<span class="source-line-no">085</span><span id="line-85"> }</span>
<span class="source-line-no">086</span><span id="line-86"></span>
<span class="source-line-no">087</span><span id="line-87"> @Override</span>
<span class="source-line-no">088</span><span id="line-88"> public String toString() {</span>
<span class="source-line-no">089</span><span id="line-89"> return "DESCENDING";</span>
<span class="source-line-no">090</span><span id="line-90"> }</span>
<span class="source-line-no">091</span><span id="line-91"> };</span>
<span class="source-line-no">092</span><span id="line-92"></span>
<span class="source-line-no">093</span><span id="line-93"> /**</span>
<span class="source-line-no">094</span><span id="line-94"> * Returns the adjusted trichotomous value according to the ordering imposed by this</span>
<span class="source-line-no">095</span><span id="line-95"> * {@code Order}.</span>
<span class="source-line-no">096</span><span id="line-96"> */</span>
<span class="source-line-no">097</span><span id="line-97"> public abstract int cmp(int cmp);</span>
<span class="source-line-no">098</span><span id="line-98"></span>
<span class="source-line-no">099</span><span id="line-99"> /**</span>
<span class="source-line-no">100</span><span id="line-100"> * Apply order to the byte {@code val}.</span>
<span class="source-line-no">101</span><span id="line-101"> */</span>
<span class="source-line-no">102</span><span id="line-102"> public abstract byte apply(byte val);</span>
<span class="source-line-no">103</span><span id="line-103"></span>
<span class="source-line-no">104</span><span id="line-104"> /**</span>
<span class="source-line-no">105</span><span id="line-105"> * Apply order to the byte array {@code val}.</span>
<span class="source-line-no">106</span><span id="line-106"> */</span>
<span class="source-line-no">107</span><span id="line-107"> public abstract void apply(byte[] val);</span>
<span class="source-line-no">108</span><span id="line-108"></span>
<span class="source-line-no">109</span><span id="line-109"> /**</span>
<span class="source-line-no">110</span><span id="line-110"> * Apply order to a range within the byte array {@code val}.</span>
<span class="source-line-no">111</span><span id="line-111"> */</span>
<span class="source-line-no">112</span><span id="line-112"> public abstract void apply(byte[] val, int offset, int length);</span>
<span class="source-line-no">113</span><span id="line-113">}</span>
</pre>
</div>
</main>
</body>
</html>