Google Git
Sign in
apache / yetus / 279759194bd2040d20964cdc871a434f2a1fb542 / . / documentation / 0.12.0 / javadocs / index-all.html
blob: 904e7b841ed5b485c92732fabd130bbb7c0d6827 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_242) on Mon Apr 13 23:16:05 UTC 2020 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Index (Apache Yetus Project 0.12.0 API)</title>
<meta name="date" content="2020-04-13">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Apache Yetus Project 0.12.0 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#I:E">E</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:V">V</a>&nbsp;<a name="I:E">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools"><span class="typeNameLink">ExcludePrivateAnnotationsJDiffDoclet</span></a> - Class in <a href="org/apache/yetus/audience/tools/package-summary.html">org.apache.yetus.audience.tools</a></dt>
<dd>
<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/jdk/api/javadoc/doclet/">Doclet</a>
for excluding elements that are annotated with
<a href="org/apache/yetus/audience/InterfaceAudience.Private.html" title="annotation in org.apache.yetus.audience"><code>InterfaceAudience.Private</code></a> or
<a href="org/apache/yetus/audience/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.yetus.audience"><code>InterfaceAudience.LimitedPrivate</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html#ExcludePrivateAnnotationsJDiffDoclet--">ExcludePrivateAnnotationsJDiffDoclet()</a></span> - Constructor for class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools"><span class="typeNameLink">ExcludePrivateAnnotationsStandardDoclet</span></a> - Class in <a href="org/apache/yetus/audience/tools/package-summary.html">org.apache.yetus.audience.tools</a></dt>
<dd>
<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/jdk/api/javadoc/doclet/">Doclet</a>
for excluding elements that are annotated with
<a href="org/apache/yetus/audience/InterfaceAudience.Private.html" title="annotation in org.apache.yetus.audience"><code>InterfaceAudience.Private</code></a> or
<a href="org/apache/yetus/audience/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.yetus.audience"><code>InterfaceAudience.LimitedPrivate</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html#ExcludePrivateAnnotationsStandardDoclet--">ExcludePrivateAnnotationsStandardDoclet()</a></span> - Constructor for class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:I">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools"><span class="typeNameLink">IncludePublicAnnotationsStandardDoclet</span></a> - Class in <a href="org/apache/yetus/audience/tools/package-summary.html">org.apache.yetus.audience.tools</a></dt>
<dd>
<div class="block">A <a href="https://docs.oracle.com/javase/8/docs/jdk/api/javadoc/doclet/">Doclet</a>
that only includes class-level elements that are annotated with
<a href="org/apache/yetus/audience/InterfaceAudience.Public.html" title="annotation in org.apache.yetus.audience"><code>InterfaceAudience.Public</code></a>.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html#IncludePublicAnnotationsStandardDoclet--">IncludePublicAnnotationsStandardDoclet()</a></span> - Constructor for class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/yetus/audience/InterfaceAudience.html" title="class in org.apache.yetus.audience"><span class="typeNameLink">InterfaceAudience</span></a> - Class in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Annotation to inform users of a package, class or method's intended audience.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceAudience.LimitedPrivate.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceAudience.LimitedPrivate</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Intended only for the project(s) specified in the annotation.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceAudience.Private.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceAudience.Private</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Intended for use only within a given project.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceAudience.Public.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceAudience.Public</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Intended for use by any project or application.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceStability.html" title="class in org.apache.yetus.audience"><span class="typeNameLink">InterfaceStability</span></a> - Class in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Annotation to inform users of how much to rely on a particular package,
class or method not changing over time.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/InterfaceStability.html#InterfaceStability--">InterfaceStability()</a></span> - Constructor for class org.apache.yetus.audience.<a href="org/apache/yetus/audience/InterfaceStability.html" title="class in org.apache.yetus.audience">InterfaceStability</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/yetus/audience/InterfaceStability.Evolving.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceStability.Evolving</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Evolving, but can break compatibility at minor release (i.e.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceStability.Stable.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceStability.Stable</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">Can evolve while retaining compatibility for minor release boundaries.</div>
</dd>
<dt><a href="org/apache/yetus/audience/InterfaceStability.Unstable.html" title="annotation in org.apache.yetus.audience"><span class="typeNameLink">InterfaceStability.Unstable</span></a> - Annotation Type in <a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a></dt>
<dd>
<div class="block">No guarantee is provided as to reliability or stability across any
level of release granularity.</div>
</dd>
</dl>
<a name="I:L">
<!-- -->
</a>
<h2 class="title">L</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html#languageVersion--">languageVersion()</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html#languageVersion--">languageVersion()</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html#languageVersion--">languageVersion()</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:M">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/yetus/releasedocmaker/ReleaseDocMaker.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class org.apache.yetus.releasedocmaker.<a href="org/apache/yetus/releasedocmaker/ReleaseDocMaker.html" title="class in org.apache.yetus.releasedocmaker">ReleaseDocMaker</a></dt>
<dd>
<div class="block">This method calls the main() method of the shelldocs Python program.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/shelldocs/ShellDocs.html#main-java.lang.String:A-">main(String[])</a></span> - Static method in class org.apache.yetus.shelldocs.<a href="org/apache/yetus/shelldocs/ShellDocs.html" title="class in org.apache.yetus.shelldocs">ShellDocs</a></dt>
<dd>
<div class="block">This method calls the main() method of the shelldocs Python program.</div>
</dd>
</dl>
<a name="I:O">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html#optionLength-java.lang.String-">optionLength(String)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html#optionLength-java.lang.String-">optionLength(String)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html#optionLength-java.lang.String-">optionLength(String)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/yetus/audience/package-summary.html">org.apache.yetus.audience</a> - package org.apache.yetus.audience</dt>
<dd>
<div class="block">Audience annotations.</div>
</dd>
<dt><a href="org/apache/yetus/audience/tools/package-summary.html">org.apache.yetus.audience.tools</a> - package org.apache.yetus.audience.tools</dt>
<dd>
<div class="block">Audience annotations.</div>
</dd>
<dt><a href="org/apache/yetus/maven/plugin/fileops/package-summary.html">org.apache.yetus.maven.plugin.fileops</a> - package org.apache.yetus.maven.plugin.fileops</dt>
<dd>
<div class="block">Utilities for various file operations.</div>
</dd>
<dt><a href="org/apache/yetus/maven/plugin/rdm/package-summary.html">org.apache.yetus.maven.plugin.rdm</a> - package org.apache.yetus.maven.plugin.rdm</dt>
<dd>
<div class="block">Utilities for running releasedocmaker.</div>
</dd>
<dt><a href="org/apache/yetus/maven/plugin/shelldocs/package-summary.html">org.apache.yetus.maven.plugin.shelldocs</a> - package org.apache.yetus.maven.plugin.shelldocs</dt>
<dd>
<div class="block">Utilities for running releasedocmaker.</div>
</dd>
<dt><a href="org/apache/yetus/maven/plugin/utils/package-summary.html">org.apache.yetus.maven.plugin.utils</a> - package org.apache.yetus.maven.plugin.utils</dt>
<dd>
<div class="block">Utilities for running Yetus.</div>
</dd>
<dt><a href="org/apache/yetus/releasedocmaker/package-summary.html">org.apache.yetus.releasedocmaker</a> - package org.apache.yetus.releasedocmaker</dt>
<dd>&nbsp;</dd>
<dt><a href="org/apache/yetus/shelldocs/package-summary.html">org.apache.yetus.shelldocs</a> - package org.apache.yetus.shelldocs</dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:R">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><a href="org/apache/yetus/releasedocmaker/ReleaseDocMaker.html" title="class in org.apache.yetus.releasedocmaker"><span class="typeNameLink">ReleaseDocMaker</span></a> - Class in <a href="org/apache/yetus/releasedocmaker/package-summary.html">org.apache.yetus.releasedocmaker</a></dt>
<dd>
<div class="block">Jython-based interface to releasedocmaker.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/releasedocmaker/ReleaseDocMaker.html#ReleaseDocMaker--">ReleaseDocMaker()</a></span> - Constructor for class org.apache.yetus.releasedocmaker.<a href="org/apache/yetus/releasedocmaker/ReleaseDocMaker.html" title="class in org.apache.yetus.releasedocmaker">ReleaseDocMaker</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:S">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><a href="org/apache/yetus/shelldocs/ShellDocs.html" title="class in org.apache.yetus.shelldocs"><span class="typeNameLink">ShellDocs</span></a> - Class in <a href="org/apache/yetus/shelldocs/package-summary.html">org.apache.yetus.shelldocs</a></dt>
<dd>
<div class="block">Jython-based interface to shelldocs.</div>
</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/shelldocs/ShellDocs.html#ShellDocs--">ShellDocs()</a></span> - Constructor for class org.apache.yetus.shelldocs.<a href="org/apache/yetus/shelldocs/ShellDocs.html" title="class in org.apache.yetus.shelldocs">ShellDocs</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html#start-com.sun.javadoc.RootDoc-">start(RootDoc)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html#start-com.sun.javadoc.RootDoc-">start(RootDoc)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html#start-com.sun.javadoc.RootDoc-">start(RootDoc)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="I:V">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html#validOptions-java.lang.String:A:A-com.sun.javadoc.DocErrorReporter-">validOptions(String[][], DocErrorReporter)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsJDiffDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsJDiffDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html#validOptions-java.lang.String:A:A-com.sun.javadoc.DocErrorReporter-">validOptions(String[][], DocErrorReporter)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/ExcludePrivateAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">ExcludePrivateAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
<dt><span class="memberNameLink"><a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html#validOptions-java.lang.String:A:A-com.sun.javadoc.DocErrorReporter-">validOptions(String[][], DocErrorReporter)</a></span> - Static method in class org.apache.yetus.audience.tools.<a href="org/apache/yetus/audience/tools/IncludePublicAnnotationsStandardDoclet.html" title="class in org.apache.yetus.audience.tools">IncludePublicAnnotationsStandardDoclet</a></dt>
<dd>&nbsp;</dd>
</dl>
<a href="#I:E">E</a>&nbsp;<a href="#I:I">I</a>&nbsp;<a href="#I:L">L</a>&nbsp;<a href="#I:M">M</a>&nbsp;<a href="#I:O">O</a>&nbsp;<a href="#I:R">R</a>&nbsp;<a href="#I:S">S</a>&nbsp;<a href="#I:V">V</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?index-all.html" target="_top">Frames</a></li>
<li><a href="index-all.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>