Google Git
Sign in
apache / hbase-site / 0082cda45f48d1755543336c908ec6d80d4ec0a9 / . / testdevapidocs / src-html / org / apache / hadoop / hbase / util / BuilderStyleTest.html
blob: 93e1eb13e8e225a770d61b1d9cf225e346eba206 [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, class: BuilderStyleTest">
<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 static org.junit.Assert.assertTrue;</span>
<span class="source-line-no">021</span><span id="line-21"></span>
<span class="source-line-no">022</span><span id="line-22">import java.lang.reflect.Method;</span>
<span class="source-line-no">023</span><span id="line-23">import java.lang.reflect.Modifier;</span>
<span class="source-line-no">024</span><span id="line-24">import java.util.HashMap;</span>
<span class="source-line-no">025</span><span id="line-25">import java.util.HashSet;</span>
<span class="source-line-no">026</span><span id="line-26">import java.util.Map;</span>
<span class="source-line-no">027</span><span id="line-27">import java.util.Set;</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"> * Utility class to check whether a given class conforms to builder-style: Foo foo = new Foo()</span>
<span class="source-line-no">031</span><span id="line-31"> * .setBar(bar) .setBaz(baz)</span>
<span class="source-line-no">032</span><span id="line-32"> */</span>
<span class="source-line-no">033</span><span id="line-33">public final class BuilderStyleTest {</span>
<span class="source-line-no">034</span><span id="line-34"> private BuilderStyleTest() {</span>
<span class="source-line-no">035</span><span id="line-35"> }</span>
<span class="source-line-no">036</span><span id="line-36"></span>
<span class="source-line-no">037</span><span id="line-37"> /*</span>
<span class="source-line-no">038</span><span id="line-38"> * If a base class Foo declares a method setFoo() returning Foo, then the subclass should</span>
<span class="source-line-no">039</span><span id="line-39"> * re-declare the methods overriding the return class with the subclass: class Foo { Foo setFoo()</span>
<span class="source-line-no">040</span><span id="line-40"> * { .. return this; } } class Bar { Bar setFoo() { return (Bar) super.setFoo(); } }</span>
<span class="source-line-no">041</span><span id="line-41"> */</span>
<span class="source-line-no">042</span><span id="line-42"> @SuppressWarnings("rawtypes")</span>
<span class="source-line-no">043</span><span id="line-43"> public static void assertClassesAreBuilderStyle(Class... classes) {</span>
<span class="source-line-no">044</span><span id="line-44"> for (Class clazz : classes) {</span>
<span class="source-line-no">045</span><span id="line-45"> System.out.println("Checking " + clazz);</span>
<span class="source-line-no">046</span><span id="line-46"> Method[] methods = clazz.getDeclaredMethods();</span>
<span class="source-line-no">047</span><span id="line-47"> Map&lt;String, Set&lt;Method&gt;&gt; methodsBySignature = new HashMap&lt;&gt;();</span>
<span class="source-line-no">048</span><span id="line-48"> for (Method method : methods) {</span>
<span class="source-line-no">049</span><span id="line-49"> if (!Modifier.isPublic(method.getModifiers())) {</span>
<span class="source-line-no">050</span><span id="line-50"> continue; // only public classes</span>
<span class="source-line-no">051</span><span id="line-51"> }</span>
<span class="source-line-no">052</span><span id="line-52"> Class&lt;?&gt; ret = method.getReturnType();</span>
<span class="source-line-no">053</span><span id="line-53"> if (method.getName().startsWith("set") || method.getName().startsWith("add")) {</span>
<span class="source-line-no">054</span><span id="line-54"> System.out.println(</span>
<span class="source-line-no">055</span><span id="line-55"> " " + clazz.getSimpleName() + "." + method.getName() + "() : " + ret.getSimpleName());</span>
<span class="source-line-no">056</span><span id="line-56"></span>
<span class="source-line-no">057</span><span id="line-57"> // because of subclass / super class method overrides, we group the methods fitting the</span>
<span class="source-line-no">058</span><span id="line-58"> // same signatures because we get two method definitions from java reflection:</span>
<span class="source-line-no">059</span><span id="line-59"> // Mutation.setDurability() : Mutation</span>
<span class="source-line-no">060</span><span id="line-60"> // Delete.setDurability() : Mutation</span>
<span class="source-line-no">061</span><span id="line-61"> // Delete.setDurability() : Delete</span>
<span class="source-line-no">062</span><span id="line-62"> String sig = method.getName();</span>
<span class="source-line-no">063</span><span id="line-63"> for (Class&lt;?&gt; param : method.getParameterTypes()) {</span>
<span class="source-line-no">064</span><span id="line-64"> sig += param.getName();</span>
<span class="source-line-no">065</span><span id="line-65"> }</span>
<span class="source-line-no">066</span><span id="line-66"> Set&lt;Method&gt; sigMethods = methodsBySignature.get(sig);</span>
<span class="source-line-no">067</span><span id="line-67"> if (sigMethods == null) {</span>
<span class="source-line-no">068</span><span id="line-68"> sigMethods = new HashSet&lt;&gt;();</span>
<span class="source-line-no">069</span><span id="line-69"> methodsBySignature.put(sig, sigMethods);</span>
<span class="source-line-no">070</span><span id="line-70"> }</span>
<span class="source-line-no">071</span><span id="line-71"> sigMethods.add(method);</span>
<span class="source-line-no">072</span><span id="line-72"> }</span>
<span class="source-line-no">073</span><span id="line-73"> }</span>
<span class="source-line-no">074</span><span id="line-74"> // now iterate over the methods by signatures</span>
<span class="source-line-no">075</span><span id="line-75"> for (Map.Entry&lt;String, Set&lt;Method&gt;&gt; e : methodsBySignature.entrySet()) {</span>
<span class="source-line-no">076</span><span id="line-76"> // at least one of method sigs should return the declaring class</span>
<span class="source-line-no">077</span><span id="line-77"> boolean found = false;</span>
<span class="source-line-no">078</span><span id="line-78"> for (Method m : e.getValue()) {</span>
<span class="source-line-no">079</span><span id="line-79"> found = clazz.isAssignableFrom(m.getReturnType());</span>
<span class="source-line-no">080</span><span id="line-80"> if (found) {</span>
<span class="source-line-no">081</span><span id="line-81"> break;</span>
<span class="source-line-no">082</span><span id="line-82"> }</span>
<span class="source-line-no">083</span><span id="line-83"> }</span>
<span class="source-line-no">084</span><span id="line-84"> String errorMsg = "All setXXX()|addXX() methods in " + clazz.getSimpleName()</span>
<span class="source-line-no">085</span><span id="line-85"> + " should return a " + clazz.getSimpleName() + " object in builder style. "</span>
<span class="source-line-no">086</span><span id="line-86"> + "Offending method:" + e.getValue().iterator().next().getName();</span>
<span class="source-line-no">087</span><span id="line-87"> assertTrue(errorMsg, found);</span>
<span class="source-line-no">088</span><span id="line-88"> }</span>
<span class="source-line-no">089</span><span id="line-89"> }</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>
</pre>
</div>
</main>
</body>
</html>