Google Git
Sign in
apache / hbase-site / 5a6938ba8875b19a3d96e84a37f1016c53778aec / . / devapidocs / src-html / org / apache / hadoop / hbase / client / TableState.html
blob: d05794221a19ab93f0cb6f7bccf929490d2c7b21 [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.client, class: TableState">
<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.client;</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.hadoop.hbase.TableName;</span>
<span class="source-line-no">021</span><span id="line-21">import org.apache.hadoop.hbase.exceptions.DeserializationException;</span>
<span class="source-line-no">022</span><span id="line-22">import org.apache.yetus.audience.InterfaceAudience;</span>
<span class="source-line-no">023</span><span id="line-23">import org.apache.yetus.audience.InterfaceStability;</span>
<span class="source-line-no">024</span><span id="line-24"></span>
<span class="source-line-no">025</span><span id="line-25">import org.apache.hbase.thirdparty.com.google.protobuf.InvalidProtocolBufferException;</span>
<span class="source-line-no">026</span><span id="line-26"></span>
<span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos;</span>
<span class="source-line-no">028</span><span id="line-28"></span>
<span class="source-line-no">029</span><span id="line-29">/**</span>
<span class="source-line-no">030</span><span id="line-30"> * Represents table state.</span>
<span class="source-line-no">031</span><span id="line-31"> */</span>
<span class="source-line-no">032</span><span id="line-32">@InterfaceAudience.Private</span>
<span class="source-line-no">033</span><span id="line-33">public class TableState {</span>
<span class="source-line-no">034</span><span id="line-34"></span>
<span class="source-line-no">035</span><span id="line-35"> @InterfaceAudience.Private</span>
<span class="source-line-no">036</span><span id="line-36"> @InterfaceStability.Evolving</span>
<span class="source-line-no">037</span><span id="line-37"> public static enum State {</span>
<span class="source-line-no">038</span><span id="line-38"> ENABLED,</span>
<span class="source-line-no">039</span><span id="line-39"> DISABLED,</span>
<span class="source-line-no">040</span><span id="line-40"> DISABLING,</span>
<span class="source-line-no">041</span><span id="line-41"> ENABLING;</span>
<span class="source-line-no">042</span><span id="line-42"></span>
<span class="source-line-no">043</span><span id="line-43"> /**</span>
<span class="source-line-no">044</span><span id="line-44"> * Covert from PB version of State</span>
<span class="source-line-no">045</span><span id="line-45"> * @param state convert from</span>
<span class="source-line-no">046</span><span id="line-46"> */</span>
<span class="source-line-no">047</span><span id="line-47"> public static State convert(HBaseProtos.TableState.State state) {</span>
<span class="source-line-no">048</span><span id="line-48"> State ret;</span>
<span class="source-line-no">049</span><span id="line-49"> switch (state) {</span>
<span class="source-line-no">050</span><span id="line-50"> case ENABLED:</span>
<span class="source-line-no">051</span><span id="line-51"> ret = State.ENABLED;</span>
<span class="source-line-no">052</span><span id="line-52"> break;</span>
<span class="source-line-no">053</span><span id="line-53"> case DISABLED:</span>
<span class="source-line-no">054</span><span id="line-54"> ret = State.DISABLED;</span>
<span class="source-line-no">055</span><span id="line-55"> break;</span>
<span class="source-line-no">056</span><span id="line-56"> case DISABLING:</span>
<span class="source-line-no">057</span><span id="line-57"> ret = State.DISABLING;</span>
<span class="source-line-no">058</span><span id="line-58"> break;</span>
<span class="source-line-no">059</span><span id="line-59"> case ENABLING:</span>
<span class="source-line-no">060</span><span id="line-60"> ret = State.ENABLING;</span>
<span class="source-line-no">061</span><span id="line-61"> break;</span>
<span class="source-line-no">062</span><span id="line-62"> default:</span>
<span class="source-line-no">063</span><span id="line-63"> throw new IllegalStateException(state.toString());</span>
<span class="source-line-no">064</span><span id="line-64"> }</span>
<span class="source-line-no">065</span><span id="line-65"> return ret;</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"> /**</span>
<span class="source-line-no">069</span><span id="line-69"> * Covert to PB version of State</span>
<span class="source-line-no">070</span><span id="line-70"> */</span>
<span class="source-line-no">071</span><span id="line-71"> public HBaseProtos.TableState.State convert() {</span>
<span class="source-line-no">072</span><span id="line-72"> HBaseProtos.TableState.State state;</span>
<span class="source-line-no">073</span><span id="line-73"> switch (this) {</span>
<span class="source-line-no">074</span><span id="line-74"> case ENABLED:</span>
<span class="source-line-no">075</span><span id="line-75"> state = HBaseProtos.TableState.State.ENABLED;</span>
<span class="source-line-no">076</span><span id="line-76"> break;</span>
<span class="source-line-no">077</span><span id="line-77"> case DISABLED:</span>
<span class="source-line-no">078</span><span id="line-78"> state = HBaseProtos.TableState.State.DISABLED;</span>
<span class="source-line-no">079</span><span id="line-79"> break;</span>
<span class="source-line-no">080</span><span id="line-80"> case DISABLING:</span>
<span class="source-line-no">081</span><span id="line-81"> state = HBaseProtos.TableState.State.DISABLING;</span>
<span class="source-line-no">082</span><span id="line-82"> break;</span>
<span class="source-line-no">083</span><span id="line-83"> case ENABLING:</span>
<span class="source-line-no">084</span><span id="line-84"> state = HBaseProtos.TableState.State.ENABLING;</span>
<span class="source-line-no">085</span><span id="line-85"> break;</span>
<span class="source-line-no">086</span><span id="line-86"> default:</span>
<span class="source-line-no">087</span><span id="line-87"> throw new IllegalStateException(this.toString());</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> return state;</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"> private final TableName tableName;</span>
<span class="source-line-no">095</span><span id="line-95"> private final State state;</span>
<span class="source-line-no">096</span><span id="line-96"></span>
<span class="source-line-no">097</span><span id="line-97"> /** Returns True if table is {@link State#ENABLED}. */</span>
<span class="source-line-no">098</span><span id="line-98"> public boolean isEnabled() {</span>
<span class="source-line-no">099</span><span id="line-99"> return isInStates(State.ENABLED);</span>
<span class="source-line-no">100</span><span id="line-100"> }</span>
<span class="source-line-no">101</span><span id="line-101"></span>
<span class="source-line-no">102</span><span id="line-102"> /** Returns True if table is {@link State#ENABLING}. */</span>
<span class="source-line-no">103</span><span id="line-103"> public boolean isEnabling() {</span>
<span class="source-line-no">104</span><span id="line-104"> return isInStates(State.ENABLING);</span>
<span class="source-line-no">105</span><span id="line-105"> }</span>
<span class="source-line-no">106</span><span id="line-106"></span>
<span class="source-line-no">107</span><span id="line-107"> /** Returns True if {@link State#ENABLED} or {@link State#ENABLING} */</span>
<span class="source-line-no">108</span><span id="line-108"> public boolean isEnabledOrEnabling() {</span>
<span class="source-line-no">109</span><span id="line-109"> return isInStates(State.ENABLED, State.ENABLING);</span>
<span class="source-line-no">110</span><span id="line-110"> }</span>
<span class="source-line-no">111</span><span id="line-111"></span>
<span class="source-line-no">112</span><span id="line-112"> /** Returns True if table is disabled. */</span>
<span class="source-line-no">113</span><span id="line-113"> public boolean isDisabled() {</span>
<span class="source-line-no">114</span><span id="line-114"> return isInStates(State.DISABLED);</span>
<span class="source-line-no">115</span><span id="line-115"> }</span>
<span class="source-line-no">116</span><span id="line-116"></span>
<span class="source-line-no">117</span><span id="line-117"> /** Returns True if table is disabling. */</span>
<span class="source-line-no">118</span><span id="line-118"> public boolean isDisabling() {</span>
<span class="source-line-no">119</span><span id="line-119"> return isInStates(State.DISABLING);</span>
<span class="source-line-no">120</span><span id="line-120"> }</span>
<span class="source-line-no">121</span><span id="line-121"></span>
<span class="source-line-no">122</span><span id="line-122"> /** Returns True if {@link State#DISABLED} or {@link State#DISABLED} */</span>
<span class="source-line-no">123</span><span id="line-123"> public boolean isDisabledOrDisabling() {</span>
<span class="source-line-no">124</span><span id="line-124"> return isInStates(State.DISABLED, State.DISABLING);</span>
<span class="source-line-no">125</span><span id="line-125"> }</span>
<span class="source-line-no">126</span><span id="line-126"></span>
<span class="source-line-no">127</span><span id="line-127"> /**</span>
<span class="source-line-no">128</span><span id="line-128"> * Create instance of TableState.</span>
<span class="source-line-no">129</span><span id="line-129"> * @param tableName name of the table</span>
<span class="source-line-no">130</span><span id="line-130"> * @param state table state</span>
<span class="source-line-no">131</span><span id="line-131"> */</span>
<span class="source-line-no">132</span><span id="line-132"> public TableState(TableName tableName, State state) {</span>
<span class="source-line-no">133</span><span id="line-133"> this.tableName = tableName;</span>
<span class="source-line-no">134</span><span id="line-134"> this.state = state;</span>
<span class="source-line-no">135</span><span id="line-135"> }</span>
<span class="source-line-no">136</span><span id="line-136"></span>
<span class="source-line-no">137</span><span id="line-137"> /** Returns table state */</span>
<span class="source-line-no">138</span><span id="line-138"> public State getState() {</span>
<span class="source-line-no">139</span><span id="line-139"> return state;</span>
<span class="source-line-no">140</span><span id="line-140"> }</span>
<span class="source-line-no">141</span><span id="line-141"></span>
<span class="source-line-no">142</span><span id="line-142"> /**</span>
<span class="source-line-no">143</span><span id="line-143"> * Table name for state</span>
<span class="source-line-no">144</span><span id="line-144"> */</span>
<span class="source-line-no">145</span><span id="line-145"> public TableName getTableName() {</span>
<span class="source-line-no">146</span><span id="line-146"> return tableName;</span>
<span class="source-line-no">147</span><span id="line-147"> }</span>
<span class="source-line-no">148</span><span id="line-148"></span>
<span class="source-line-no">149</span><span id="line-149"> /**</span>
<span class="source-line-no">150</span><span id="line-150"> * Check that table in given states</span>
<span class="source-line-no">151</span><span id="line-151"> * @param state state</span>
<span class="source-line-no">152</span><span id="line-152"> * @return true if satisfies</span>
<span class="source-line-no">153</span><span id="line-153"> */</span>
<span class="source-line-no">154</span><span id="line-154"> public boolean inStates(State state) {</span>
<span class="source-line-no">155</span><span id="line-155"> return this.state.equals(state);</span>
<span class="source-line-no">156</span><span id="line-156"> }</span>
<span class="source-line-no">157</span><span id="line-157"></span>
<span class="source-line-no">158</span><span id="line-158"> /**</span>
<span class="source-line-no">159</span><span id="line-159"> * Check that table in given states</span>
<span class="source-line-no">160</span><span id="line-160"> * @param states state list</span>
<span class="source-line-no">161</span><span id="line-161"> * @return true if satisfies</span>
<span class="source-line-no">162</span><span id="line-162"> */</span>
<span class="source-line-no">163</span><span id="line-163"> public boolean inStates(State... states) {</span>
<span class="source-line-no">164</span><span id="line-164"> for (State s : states) {</span>
<span class="source-line-no">165</span><span id="line-165"> if (s.equals(this.state)) return true;</span>
<span class="source-line-no">166</span><span id="line-166"> }</span>
<span class="source-line-no">167</span><span id="line-167"> return false;</span>
<span class="source-line-no">168</span><span id="line-168"> }</span>
<span class="source-line-no">169</span><span id="line-169"></span>
<span class="source-line-no">170</span><span id="line-170"> /**</span>
<span class="source-line-no">171</span><span id="line-171"> * Covert to PB version of TableState</span>
<span class="source-line-no">172</span><span id="line-172"> */</span>
<span class="source-line-no">173</span><span id="line-173"> public HBaseProtos.TableState convert() {</span>
<span class="source-line-no">174</span><span id="line-174"> return HBaseProtos.TableState.newBuilder().setState(this.state.convert()).build();</span>
<span class="source-line-no">175</span><span id="line-175"> }</span>
<span class="source-line-no">176</span><span id="line-176"></span>
<span class="source-line-no">177</span><span id="line-177"> /**</span>
<span class="source-line-no">178</span><span id="line-178"> * Covert from PB version of TableState</span>
<span class="source-line-no">179</span><span id="line-179"> * @param tableName table this state of</span>
<span class="source-line-no">180</span><span id="line-180"> * @param tableState convert from</span>
<span class="source-line-no">181</span><span id="line-181"> */</span>
<span class="source-line-no">182</span><span id="line-182"> public static TableState convert(TableName tableName, HBaseProtos.TableState tableState) {</span>
<span class="source-line-no">183</span><span id="line-183"> TableState.State state = State.convert(tableState.getState());</span>
<span class="source-line-no">184</span><span id="line-184"> return new TableState(tableName, state);</span>
<span class="source-line-no">185</span><span id="line-185"> }</span>
<span class="source-line-no">186</span><span id="line-186"></span>
<span class="source-line-no">187</span><span id="line-187"> public static TableState parseFrom(TableName tableName, byte[] bytes)</span>
<span class="source-line-no">188</span><span id="line-188"> throws DeserializationException {</span>
<span class="source-line-no">189</span><span id="line-189"> try {</span>
<span class="source-line-no">190</span><span id="line-190"> return convert(tableName, HBaseProtos.TableState.parseFrom(bytes));</span>
<span class="source-line-no">191</span><span id="line-191"> } catch (InvalidProtocolBufferException e) {</span>
<span class="source-line-no">192</span><span id="line-192"> throw new DeserializationException(e);</span>
<span class="source-line-no">193</span><span id="line-193"> }</span>
<span class="source-line-no">194</span><span id="line-194"> }</span>
<span class="source-line-no">195</span><span id="line-195"></span>
<span class="source-line-no">196</span><span id="line-196"> /**</span>
<span class="source-line-no">197</span><span id="line-197"> * Static version of state checker</span>
<span class="source-line-no">198</span><span id="line-198"> * @param target equals to any of</span>
<span class="source-line-no">199</span><span id="line-199"> * @return true if satisfies</span>
<span class="source-line-no">200</span><span id="line-200"> */</span>
<span class="source-line-no">201</span><span id="line-201"> public boolean isInStates(State... target) {</span>
<span class="source-line-no">202</span><span id="line-202"> for (State tableState : target) {</span>
<span class="source-line-no">203</span><span id="line-203"> if (this.state.equals(tableState)) {</span>
<span class="source-line-no">204</span><span id="line-204"> return true;</span>
<span class="source-line-no">205</span><span id="line-205"> }</span>
<span class="source-line-no">206</span><span id="line-206"> }</span>
<span class="source-line-no">207</span><span id="line-207"> return false;</span>
<span class="source-line-no">208</span><span id="line-208"> }</span>
<span class="source-line-no">209</span><span id="line-209"></span>
<span class="source-line-no">210</span><span id="line-210"> @Override</span>
<span class="source-line-no">211</span><span id="line-211"> public boolean equals(Object o) {</span>
<span class="source-line-no">212</span><span id="line-212"> if (this == o) {</span>
<span class="source-line-no">213</span><span id="line-213"> return true;</span>
<span class="source-line-no">214</span><span id="line-214"> }</span>
<span class="source-line-no">215</span><span id="line-215"> if (!(o instanceof TableState)) {</span>
<span class="source-line-no">216</span><span id="line-216"> return false;</span>
<span class="source-line-no">217</span><span id="line-217"> }</span>
<span class="source-line-no">218</span><span id="line-218"> TableState that = (TableState) o;</span>
<span class="source-line-no">219</span><span id="line-219"> if (state != that.state) {</span>
<span class="source-line-no">220</span><span id="line-220"> return false;</span>
<span class="source-line-no">221</span><span id="line-221"> }</span>
<span class="source-line-no">222</span><span id="line-222"> if (tableName != null ? !tableName.equals(that.tableName) : that.tableName != null) {</span>
<span class="source-line-no">223</span><span id="line-223"> return false;</span>
<span class="source-line-no">224</span><span id="line-224"> }</span>
<span class="source-line-no">225</span><span id="line-225"> return true;</span>
<span class="source-line-no">226</span><span id="line-226"> }</span>
<span class="source-line-no">227</span><span id="line-227"></span>
<span class="source-line-no">228</span><span id="line-228"> @Override</span>
<span class="source-line-no">229</span><span id="line-229"> public int hashCode() {</span>
<span class="source-line-no">230</span><span id="line-230"> int result = (tableName != null ? tableName.hashCode() : 0);</span>
<span class="source-line-no">231</span><span id="line-231"> result = 31 * result + (state != null ? state.hashCode() : 0);</span>
<span class="source-line-no">232</span><span id="line-232"> return result;</span>
<span class="source-line-no">233</span><span id="line-233"> }</span>
<span class="source-line-no">234</span><span id="line-234"></span>
<span class="source-line-no">235</span><span id="line-235"> @Override</span>
<span class="source-line-no">236</span><span id="line-236"> public String toString() {</span>
<span class="source-line-no">237</span><span id="line-237"> return "tableName=" + tableName + ", state=" + state;</span>
<span class="source-line-no">238</span><span id="line-238"> }</span>
<span class="source-line-no">239</span><span id="line-239">}</span>
</pre>
</div>
</main>
</body>
</html>