| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>ReflectiveVisitDispatcher (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, interface: ReflectiveVisitDispatcher"> |
| <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>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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="Interface ReflectiveVisitDispatcher" class="title">Interface ReflectiveVisitDispatcher<R extends <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a>,<wbr>E></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>E</code> - Argument type</dd> |
| <dd><code>R</code> - Return type</dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ReflectiveVisitDispatcher<R extends <a href="ReflectiveVisitor.html" title="interface in org.apache.calcite.util">ReflectiveVisitor</a>,<wbr>E></span></div> |
| <div class="block">Interface for looking up methods relating to reflective visitation. One |
| possible implementation would cache the results. |
| |
| <p>Type parameter 'R' is the base class of visitoR class; type parameter 'E' |
| is the base class of visiteE class. |
| |
| <p>TODO: obsolete <a href="ReflectUtil.html#lookupVisitMethod(java.lang.Class,java.lang.Class,java.lang.String)"><code>ReflectUtil.lookupVisitMethod(java.lang.Class<?>, java.lang.Class<?>, java.lang.String)</code></a>, and use caching in |
| implementing that method.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== 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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#invokeVisitor(R,E,java.lang.String)" class="member-name-link">invokeVisitor</a><wbr>(<a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</a> visitor, |
| <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</a> visitee, |
| <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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@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-tab2 method-summary-table-tab3"><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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</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-tab2 method-summary-table-tab3"> |
| <div class="block">Looks up a visit method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@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-tab2 method-summary-table-tab3"><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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</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-tab2 method-summary-table-tab3"> |
| <div class="block">Looks up a visit method taking additional parameters beyond the |
| overloaded visitee type.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <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="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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</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> |
| </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="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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</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><? extends <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</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="invokeVisitor(R,E,java.lang.String)"> |
| <h3 id="invokeVisitor(org.apache.calcite.util.ReflectiveVisitor,java.lang.Object,java.lang.String)">invokeVisitor</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">invokeVisitor</span><wbr><span class="parameters">(<a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">R</a> visitor, |
| <a href="ReflectiveVisitDispatcher.html" title="type parameter in ReflectiveVisitDispatcher">E</a> visitee, |
| <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.</p></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>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> |
| </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> |