blob: 14acb00184f356f178759e33109defbf9c734599 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (18) -->
<title>OpenApiMetaProvider (Apache Juneau 9.0.0)</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.juneau.oapi, interface: OpenApiMetaProvider">
<meta name="generator" content="javadoc/ClassWriterImpl">
<link rel="stylesheet" type="text/css" href="../../../../javadoc.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"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span><span class="nav-bar-toggle-icon"></span></button>
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></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>
<ul class="sub-nav-list-small">
<li>
<p>Summary:</p>
<ul>
<li>Nested</li>
<li><a href="#field-summary">Field</a></li>
<li>Constr</li>
<li><a href="#method-summary">Method</a></li>
</ul>
</li>
<li>
<p>Detail:</p>
<ul>
<li>Field</li>
<li>Constr</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</li>
</ul>
</div>
<div class="sub-nav">
<div id="navbar-sub-list">
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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" disabled placeholder="Search">
<input type="reset" id="reset-button" disabled value="reset">
</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>&nbsp;<a href="package-summary.html">org.apache.juneau.oapi</a></div>
<h1 title="Interface OpenApiMetaProvider" class="title">Interface OpenApiMetaProvider</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="../AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="OpenApiParser.html" title="class in org.apache.juneau.oapi">OpenApiParser</a></code>, <code><a href="OpenApiSerializer.html" title="class in org.apache.juneau.oapi">OpenApiSerializer</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../src-html/org/apache/juneau/oapi/OpenApiMetaProvider.html#line-24">OpenApiMetaProvider</a></span><span class="extends-implements">
extends <a href="../AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></span></div>
<div class="block">Interface for providing access to <a href="OpenApiClassMeta.html" title="class in org.apache.juneau.oapi"><code>OpenApiClassMeta</code></a> and <a href="OpenApiBeanPropertyMeta.html" title="class in org.apache.juneau.oapi"><code>OpenApiBeanPropertyMeta</code></a> objects.
<h5 class='section'>See Also:</h5><ul>
<li class='link'><a class="doclink" href="../../../../index.html#jm.OpenApiDetails">OpenAPI Details</a>
</ul></div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- =========== FIELD SUMMARY =========== -->
<li>
<section class="field-summary" id="field-summary">
<h2>Field Summary</h2>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.juneau.AnnotationProvider">Fields inherited from interface&nbsp;org.apache.juneau.<a href="../AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></h3>
<code><a href="../AnnotationProvider.html#DEFAULT">DEFAULT</a>, <a href="../AnnotationProvider.html#DISABLE_ANNOTATION_CACHING">DISABLE_ANNOTATION_CACHING</a></code></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-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><a href="OpenApiBeanPropertyMeta.html" title="class in org.apache.juneau.oapi">OpenApiBeanPropertyMeta</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOpenApiBeanPropertyMeta(org.apache.juneau.BeanPropertyMeta)" class="member-name-link">getOpenApiBeanPropertyMeta</a><wbr>(<a href="../BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>&nbsp;bpm)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the language-specific metadata on the specified bean property.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="OpenApiClassMeta.html" title="class in org.apache.juneau.oapi">OpenApiClassMeta</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOpenApiClassMeta(org.apache.juneau.ClassMeta)" class="member-name-link">getOpenApiClassMeta</a><wbr>(<a href="../ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a>&lt;?&gt;&nbsp;cm)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns the language-specific metadata on the specified class.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.juneau.AnnotationProvider">Methods inherited from interface&nbsp;org.apache.juneau.<a href="../AnnotationProvider.html" title="interface in org.apache.juneau">AnnotationProvider</a></h3>
<code><a href="../AnnotationProvider.html#firstAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate)">firstAnnotation</a>, <a href="../AnnotationProvider.html#firstAnnotation(java.lang.Class,java.lang.reflect.Constructor,java.util.function.Predicate)">firstAnnotation</a>, <a href="../AnnotationProvider.html#firstAnnotation(java.lang.Class,java.lang.reflect.Field,java.util.function.Predicate)">firstAnnotation</a>, <a href="../AnnotationProvider.html#firstAnnotation(java.lang.Class,java.lang.reflect.Method,java.util.function.Predicate)">firstAnnotation</a>, <a href="../AnnotationProvider.html#firstDeclaredAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate)">firstDeclaredAnnotation</a>, <a href="../AnnotationProvider.html#forEachAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate,java.util.function.Consumer)">forEachAnnotation</a>, <a href="../AnnotationProvider.html#forEachAnnotation(java.lang.Class,java.lang.reflect.Constructor,java.util.function.Predicate,java.util.function.Consumer)">forEachAnnotation</a>, <a href="../AnnotationProvider.html#forEachAnnotation(java.lang.Class,java.lang.reflect.Field,java.util.function.Predicate,java.util.function.Consumer)">forEachAnnotation</a>, <a href="../AnnotationProvider.html#forEachAnnotation(java.lang.Class,java.lang.reflect.Method,java.util.function.Predicate,java.util.function.Consumer)">forEachAnnotation</a>, <a href="../AnnotationProvider.html#forEachDeclaredAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate,java.util.function.Consumer)">forEachDeclaredAnnotation</a>, <a href="../AnnotationProvider.html#lastAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate)">lastAnnotation</a>, <a href="../AnnotationProvider.html#lastAnnotation(java.lang.Class,java.lang.reflect.Constructor,java.util.function.Predicate)">lastAnnotation</a>, <a href="../AnnotationProvider.html#lastAnnotation(java.lang.Class,java.lang.reflect.Field,java.util.function.Predicate)">lastAnnotation</a>, <a href="../AnnotationProvider.html#lastAnnotation(java.lang.Class,java.lang.reflect.Method,java.util.function.Predicate)">lastAnnotation</a>, <a href="../AnnotationProvider.html#lastDeclaredAnnotation(java.lang.Class,java.lang.Class,java.util.function.Predicate)">lastDeclaredAnnotation</a></code></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="getOpenApiClassMeta(org.apache.juneau.ClassMeta)">
<h3>getOpenApiClassMeta</h3>
<div class="member-signature"><span class="return-type"><a href="OpenApiClassMeta.html" title="class in org.apache.juneau.oapi">OpenApiClassMeta</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/juneau/oapi/OpenApiMetaProvider.html#line-32">getOpenApiClassMeta</a></span><wbr><span class="parameters">(<a href="../ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a>&lt;?&gt;&nbsp;cm)</span></div>
<div class="block">Returns the language-specific metadata on the specified class.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>cm</code> - The class to return the metadata on.</dd>
<dt>Returns:</dt>
<dd>The metadata.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getOpenApiBeanPropertyMeta(org.apache.juneau.BeanPropertyMeta)">
<h3>getOpenApiBeanPropertyMeta</h3>
<div class="member-signature"><span class="return-type"><a href="OpenApiBeanPropertyMeta.html" title="class in org.apache.juneau.oapi">OpenApiBeanPropertyMeta</a></span>&nbsp;<span class="element-name"><a href="../../../../src-html/org/apache/juneau/oapi/OpenApiMetaProvider.html#line-40">getOpenApiBeanPropertyMeta</a></span><wbr><span class="parameters">(<a href="../BeanPropertyMeta.html" title="class in org.apache.juneau">BeanPropertyMeta</a>&nbsp;bpm)</span></div>
<div class="block">Returns the language-specific metadata on the specified bean property.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>bpm</code> - The bean property to return the metadata on.</dd>
<dt>Returns:</dt>
<dd>The metadata.</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>