| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReflectUtil (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.util, class: ReflectUtil"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.util</a></div> |
| <h1 title="Class ReflectUtil" class="title">Class ReflectUtil</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance">org.apache.calcite.util.ReflectUtil</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">ReflectUtil</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div> |
| <div class="block">Static utilities for Java reflection.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static interface </code></div> |
| <div class="col-second even-row-color"><code><a href="ReflectUtil.MethodDispatcher.html" class="type-name-link" title="interface in org.apache.calcite.util">ReflectUtil.MethodDispatcher</a><<a href="ReflectUtil.MethodDispatcher.html" title="type parameter in ReflectUtil.MethodDispatcher">T</a>></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Can invoke a method on an object of type E with return type T.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">ReflectUtil</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <R extends <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a>,<wbr> |
| E><br><a href="ReflectiveVisitDispatcher.html" title="interface in org.apache.calcite.util">ReflectiveVisitDispatcher</a><R,<wbr>E></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createDispatcher(java.lang.Class,java.lang.Class)" class="member-name-link">createDispatcher</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><R> visitorBaseClazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><E> visiteeBaseClazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a dispatcher for calls to <a href="#lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String)"><code>lookupVisitMethod(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <E,<wbr> |
| T> <a href="ReflectUtil.MethodDispatcher.html" title="interface in org.apache.calcite.util">ReflectUtil.MethodDispatcher</a><T></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#createMethodDispatcher(java.lang.Class,org.apache.calcite.util.ReflectiveVisitor,java.lang.String,java.lang.Class,java.lang.Class...)" class="member-name-link">createMethodDispatcher</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> returnClazz, |
| <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a> visitor, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><E> arg0Clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>... otherArgClasses)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Creates a dispatcher for calls to a single multi-method on a particular |
| object.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getBoxingClass(java.lang.Class)" class="member-name-link">getBoxingClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> primitiveClass)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the Java boxing class for a primitive class.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getByteBufferReadMethod(java.lang.Class)" class="member-name-link">getByteBufferReadMethod</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Uses reflection to find the correct java.nio.ByteBuffer "absolute get" |
| method for a given primitive type.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getByteBufferWriteMethod(java.lang.Class)" class="member-name-link">getByteBufferWriteMethod</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Uses reflection to find the correct java.nio.ByteBuffer "absolute put" |
| method for a given primitive type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getParameterName(java.lang.reflect.Method,int)" class="member-name-link">getParameterName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method, |
| int i)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Derives the name of the <code>i</code>th parameter of a method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUnmangledMethodName(java.lang.Class,java.lang.String,java.lang.Class%5B%5D)" class="member-name-link">getUnmangledMethodName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> declaringClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>[] paramTypes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Composes a string representing a human-readable method name (with neither |
| exception nor return type information).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUnmangledMethodName(java.lang.reflect.Method)" class="member-name-link">getUnmangledMethodName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Composes a string representing a human-readable method name (with neither |
| exception nor return type information).</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getUnqualifiedClassName(java.lang.Class)" class="member-name-link">getUnqualifiedClassName</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> c)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Gets the name of a class with no package qualifiers; if it's an inner |
| class, it will still be qualified by the containing class (X$Y).</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#invokeVisitor(org.apache.calcite.util.ReflectiveVisitor,java.lang.Object,java.lang.Class,java.lang.String)" class="member-name-link">invokeVisitor</a><wbr>(<a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a> visitor, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> visitee, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> hierarchyRoot, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Implements the <a href="Glossary.html#VISITOR_PATTERN"><code>Glossary.VISITOR_PATTERN</code></a> via |
| reflection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isParameterOptional(java.lang.reflect.Method,int)" class="member-name-link">isParameterOptional</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method, |
| int i)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Derives whether the <code>i</code>th parameter of a method is optional.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String)" class="member-name-link">lookupVisitMethod</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visitorClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visiteeClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Looks up a visit method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static @Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String,java.util.List)" class="member-name-link">lookupVisitMethod</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visitorClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visiteeClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>> additionalParameterTypes)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Looks up a visit method taking additional parameters beyond the |
| overloaded visitee type.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#mightBeAssignableFrom(java.lang.Class,java.lang.Class)" class="member-name-link">mightBeAssignableFrom</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> parameterType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> argumentType)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns whether a parameter of a given type could possibly have an |
| argument of a given type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>ReflectUtil</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">ReflectUtil</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="getByteBufferReadMethod(java.lang.Class)"> |
| <h3>getByteBufferReadMethod</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></span> <span class="element-name">getByteBufferReadMethod</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</span></div> |
| <div class="block">Uses reflection to find the correct java.nio.ByteBuffer "absolute get" |
| method for a given primitive type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - the Class object representing the primitive type</dd> |
| <dt>Returns:</dt> |
| <dd>corresponding method</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getByteBufferWriteMethod(java.lang.Class)"> |
| <h3>getByteBufferWriteMethod</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></span> <span class="element-name">getByteBufferWriteMethod</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> clazz)</span></div> |
| <div class="block">Uses reflection to find the correct java.nio.ByteBuffer "absolute put" |
| method for a given primitive type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>clazz</code> - the Class object representing the primitive type</dd> |
| <dt>Returns:</dt> |
| <dd>corresponding method</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getBoxingClass(java.lang.Class)"> |
| <h3>getBoxingClass</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a></span> <span class="element-name">getBoxingClass</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> primitiveClass)</span></div> |
| <div class="block">Gets the Java boxing class for a primitive class.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>primitiveClass</code> - representative class for primitive (e.g. |
| java.lang.Integer.TYPE)</dd> |
| <dt>Returns:</dt> |
| <dd>corresponding boxing Class (e.g. java.lang.Integer)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnqualifiedClassName(java.lang.Class)"> |
| <h3>getUnqualifiedClassName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUnqualifiedClassName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> c)</span></div> |
| <div class="block">Gets the name of a class with no package qualifiers; if it's an inner |
| class, it will still be qualified by the containing class (X$Y).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>c</code> - the class of interest</dd> |
| <dt>Returns:</dt> |
| <dd>the unqualified name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnmangledMethodName(java.lang.Class,java.lang.String,java.lang.Class[])"> |
| <h3>getUnmangledMethodName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUnmangledMethodName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> declaringClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>[] paramTypes)</span></div> |
| <div class="block">Composes a string representing a human-readable method name (with neither |
| exception nor return type information).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>declaringClass</code> - class on which method is defined</dd> |
| <dd><code>methodName</code> - simple name of method without signature</dd> |
| <dd><code>paramTypes</code> - method parameter types</dd> |
| <dt>Returns:</dt> |
| <dd>unmangled method name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getUnmangledMethodName(java.lang.reflect.Method)"> |
| <h3>getUnmangledMethodName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getUnmangledMethodName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method)</span></div> |
| <div class="block">Composes a string representing a human-readable method name (with neither |
| exception nor return type information).</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>method</code> - method whose name is to be generated</dd> |
| <dt>Returns:</dt> |
| <dd>unmangled method name</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="invokeVisitor(org.apache.calcite.util.ReflectiveVisitor,java.lang.Object,java.lang.Class,java.lang.String)"> |
| <h3>invokeVisitor</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">invokeVisitor</span><wbr><span class="parameters">(<a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a> visitor, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a> visitee, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a> hierarchyRoot, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName)</span></div> |
| <div class="block">Implements the <a href="Glossary.html#VISITOR_PATTERN"><code>Glossary.VISITOR_PATTERN</code></a> via |
| reflection. The basic technique is taken from <a href="http://www.javaworld.com/javaworld/javatips/jw-javatip98.html">a |
| Javaworld article</a>. For an example of how to use it, see |
| <code>ReflectVisitorTest</code>. |
| |
| <p>Visit method lookup follows the same rules as if |
| compile-time resolution for VisitorClass.visit(VisiteeClass) were |
| performed. An ambiguous match due to multiple interface inheritance |
| results in an IllegalArgumentException. A non-match is indicated by |
| returning false.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>visitor</code> - object whose visit method is to be invoked</dd> |
| <dd><code>visitee</code> - object to be passed as a parameter to the visit |
| method</dd> |
| <dd><code>hierarchyRoot</code> - if non-null, visitor method will only be invoked if |
| it takes a parameter whose type is a subtype of |
| hierarchyRoot</dd> |
| <dd><code>visitMethodName</code> - name of visit method, e.g. "visit"</dd> |
| <dt>Returns:</dt> |
| <dd>true if a matching visit method was found and invoked</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String)"> |
| <h3>lookupVisitMethod</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></span> <span class="element-name">lookupVisitMethod</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visitorClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visiteeClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName)</span></div> |
| <div class="block">Looks up a visit method.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>visitorClass</code> - class of object whose visit method is to be invoked</dd> |
| <dd><code>visiteeClass</code> - class of object to be passed as a parameter to the |
| visit method</dd> |
| <dd><code>visitMethodName</code> - name of visit method</dd> |
| <dt>Returns:</dt> |
| <dd>method found, or null if none found</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String,java.util.List)"> |
| <h3>lookupVisitMethod</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">@Nullable <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a></span> <span class="element-name">lookupVisitMethod</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visitorClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> visiteeClass, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> visitMethodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>> additionalParameterTypes)</span></div> |
| <div class="block">Looks up a visit method taking additional parameters beyond the |
| overloaded visitee type.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>visitorClass</code> - class of object whose visit method is to be |
| invoked</dd> |
| <dd><code>visiteeClass</code> - class of object to be passed as a parameter |
| to the visit method</dd> |
| <dd><code>visitMethodName</code> - name of visit method</dd> |
| <dd><code>additionalParameterTypes</code> - list of additional parameter types</dd> |
| <dt>Returns:</dt> |
| <dd>method found, or null if none found</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#createDispatcher(java.lang.Class,java.lang.Class)"><code>createDispatcher(Class, Class)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createDispatcher(java.lang.Class,java.lang.Class)"> |
| <h3>createDispatcher</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><R extends <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a>,<wbr> |
| E></span> |
| <span class="return-type"><a href="ReflectiveVisitDispatcher.html" title="interface in org.apache.calcite.util">ReflectiveVisitDispatcher</a><R,<wbr>E></span> <span class="element-name">createDispatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><R> visitorBaseClazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><E> visiteeBaseClazz)</span></div> |
| <div class="block">Creates a dispatcher for calls to <a href="#lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String)"><code>lookupVisitMethod(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)</code></a>. The |
| dispatcher caches methods between invocations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>visitorBaseClazz</code> - Visitor base class</dd> |
| <dd><code>visiteeBaseClazz</code> - Visitee base class</dd> |
| <dt>Returns:</dt> |
| <dd>cache of methods</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createMethodDispatcher(java.lang.Class,org.apache.calcite.util.ReflectiveVisitor,java.lang.String,java.lang.Class,java.lang.Class...)"> |
| <h3>createMethodDispatcher</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="type-parameters"><E,<wbr> |
| T></span> <span class="return-type"><a href="ReflectUtil.MethodDispatcher.html" title="interface in org.apache.calcite.util">ReflectUtil.MethodDispatcher</a><T></span> <span class="element-name">createMethodDispatcher</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><T> returnClazz, |
| <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a> visitor, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> methodName, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><E> arg0Clazz, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>... otherArgClasses)</span></div> |
| <div class="block">Creates a dispatcher for calls to a single multi-method on a particular |
| object. |
| |
| <p>Calls to that multi-method are resolved by looking for a method on |
| the runtime type of that object, with the required name, and with |
| the correct type or a subclass for the first argument, and precisely the |
| same types for other arguments. |
| |
| <p>For instance, a dispatcher created for the method |
| |
| <blockquote>String foo(Vehicle, int, List)</blockquote> |
| |
| <p>could be used to call the methods |
| |
| <blockquote>String foo(Car, int, List)<br> |
| String foo(Bus, int, List)</blockquote> |
| |
| <p>(because Car and Bus are subclasses of Vehicle, and they occur in the |
| polymorphic first argument) but not the method |
| |
| <blockquote>String foo(Car, int, ArrayList)</blockquote> |
| |
| <p>(only the first argument is polymorphic). |
| |
| <p>You must create an implementation of the method for the base class. |
| Otherwise throws <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link"><code>IllegalArgumentException</code></a>.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>returnClazz</code> - Return type of method</dd> |
| <dd><code>visitor</code> - Object on which to invoke the method</dd> |
| <dd><code>methodName</code> - Name of method</dd> |
| <dd><code>arg0Clazz</code> - Base type of argument zero</dd> |
| <dd><code>otherArgClasses</code> - Types of remaining arguments</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getParameterName(java.lang.reflect.Method,int)"> |
| <h3>getParameterName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name">getParameterName</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method, |
| int i)</span></div> |
| <div class="block">Derives the name of the <code>i</code>th parameter of a method.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isParameterOptional(java.lang.reflect.Method,int)"> |
| <h3>isParameterOptional</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">isParameterOptional</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/reflect/Method.html" title="class or interface in java.lang.reflect" class="external-link">Method</a> method, |
| int i)</span></div> |
| <div class="block">Derives whether the <code>i</code>th parameter of a method is optional.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="mightBeAssignableFrom(java.lang.Class,java.lang.Class)"> |
| <h3>mightBeAssignableFrom</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name">mightBeAssignableFrom</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> parameterType, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?> argumentType)</span></div> |
| <div class="block">Returns whether a parameter of a given type could possibly have an |
| argument of a given type. |
| |
| <p>For example, consider method |
| |
| <blockquote> |
| <code>foo(Object o, String s, int i, Number n, BigDecimal d</code> |
| </blockquote> |
| |
| <p>To which which of those parameters could I pass a value that is an |
| instance of <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/HashMap.html" title="class or interface in java.util" class="external-link"><code>HashMap</code></a>? The answer: |
| |
| <ul> |
| <li><code>o</code> yes, |
| <li><code>s</code> no (<code>String</code> is a final class), |
| <li><code>i</code> no, |
| <li><code>n</code> yes (<code>Number</code> is an interface, and <code>HashMap</code> is |
| a non-final class, so I could create a sub-class of <code>HashMap</code> |
| that implements <code>Number</code>, |
| <li><code>d</code> yes (<code>BigDecimal</code> is a non-final class). |
| </ul></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
