Google Git
Sign in
apache / juneau-website / 3ec6a38af8eff23af4011afbc4a002edec02bd97 / . / content / site / apidocs-9.0.0 / org / apache / juneau / examples / rest / HtmlBeansResource.html
blob: 544b47f08d9b32066f1358f3c0bd7ddf2a5caf83 [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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>HtmlBeansResource (Apache Juneau 9.0.0)</title>
<link rel="stylesheet" type="text/css" href="../../../../../javadoc.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="HtmlBeansResource (Apache Juneau 9.0.0)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/juneau/examples/rest/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/examples/rest/PhotosResource.html" title="class in org.apache.juneau.examples.rest"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/examples/rest/HtmlBeansResource.html" target="_top">Frames</a></li>
<li><a href="HtmlBeansResource.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.juneau.examples.rest</div>
<h2 title="Class HtmlBeansResource" class="title">Class HtmlBeansResource</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html" title="class in org.apache.juneau.rest.servlet">org.apache.juneau.rest.servlet.RestObject</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet">org.apache.juneau.rest.servlet.BasicRestObject</a></li>
<li>
<ul class="inheritance">
<li>org.apache.juneau.examples.rest.HtmlBeansResource</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/juneau/rest/config/BasicJsonConfig.html" title="interface in org.apache.juneau.rest.config">BasicJsonConfig</a>, <a href="../../../../../org/apache/juneau/rest/config/BasicUniversalConfig.html" title="interface in org.apache.juneau.rest.config">BasicUniversalConfig</a>, <a href="../../../../../org/apache/juneau/rest/config/DefaultConfig.html" title="interface in org.apache.juneau.rest.config">DefaultConfig</a>, <a href="../../../../../org/apache/juneau/rest/config/DefaultHtmlConfig.html" title="interface in org.apache.juneau.rest.config">DefaultHtmlConfig</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestOperations.html" title="interface in org.apache.juneau.rest.servlet">BasicRestOperations</a></dd>
</dl>
<hr>
<br>
<pre>public class <a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.57">HtmlBeansResource</a>
extends <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet">BasicRestObject</a>
implements <a href="../../../../../org/apache/juneau/rest/config/BasicUniversalConfig.html" title="interface in org.apache.juneau.rest.config">BasicUniversalConfig</a></pre>
<div class="block">Sample resource that allows images to be uploaded and retrieved.
<ul class='seealso'>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.jrs.Marshalling'>REST Marshalling</a>
<li class='link'><a class='doclink' href='../../../../../overview-summary.html#juneau-rest-server.jrs.HtmlBeans'>HtmlBeans</a>
<li class='extlink'><a class='doclink' target='_blank' href='https://github.com/apache/juneau/blob/master/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/HtmlBeansResource.java'>Source</a>
</ul></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html#HtmlBeansResource--">HtmlBeansResource</a></span>()</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/html5/HtmlElement.html" title="class in org.apache.juneau.dto.html5">HtmlElement</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html#aDiv--">aDiv</a></span>()</code>
<div class="block">[HTTP GET /htmlbeans/div]</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/html5/Form.html" title="class in org.apache.juneau.dto.html5">Form</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html#aForm--">aForm</a></span>()</code>
<div class="block">[HTTP GET /htmlbeans/form]</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/html5/Table.html" title="class in org.apache.juneau.dto.html5">Table</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html#aTable--">aTable</a></span>()</code>
<div class="block">[HTTP GET /htmlbeans/table]</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/juneau/rest/beans/ResourceDescriptions.html" title="class in org.apache.juneau.rest.beans">ResourceDescriptions</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/examples/rest/HtmlBeansResource.html#getChildDescriptions--">getChildDescriptions</a></span>()</code>
<div class="block">[HTTP GET /htmlbeans]</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.servlet.BasicRestObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.rest.servlet.<a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html" title="class in org.apache.juneau.rest.servlet">BasicRestObject</a></h3>
<code><a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html#error--">error</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html#getFavIcon--">getFavIcon</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html#getHtdoc-java.lang.String-java.util.Locale-">getHtdoc</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html#getStats-org.apache.juneau.rest.RestRequest-">getStats</a>, <a href="../../../../../org/apache/juneau/rest/servlet/BasicRestObject.html#getSwagger-org.apache.juneau.rest.RestRequest-">getSwagger</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.servlet.RestObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.juneau.rest.servlet.<a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html" title="class in org.apache.juneau.rest.servlet">RestObject</a></h3>
<code><a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#doLog-java.util.logging.Level-java.lang.Throwable-java.util.function.Supplier-">doLog</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#getContext--">getContext</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#getRequest--">getRequest</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#getResponse--">getResponse</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#log-java.util.logging.Level-java.lang.Throwable-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#log-java.lang.String-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#log-java.lang.String-java.lang.Throwable-">log</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onDestroy-org.apache.juneau.rest.RestContext-">onDestroy</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onEndCall-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">onEndCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onInit-org.apache.juneau.rest.RestContext.Builder-">onInit</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onPostCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPostCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onPostInit-org.apache.juneau.rest.RestContext-">onPostInit</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onPostInitChildFirst-org.apache.juneau.rest.RestContext-">onPostInitChildFirst</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onPreCall-org.apache.juneau.rest.RestRequest-org.apache.juneau.rest.RestResponse-">onPreCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#onStartCall-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">onStartCall</a>, <a href="../../../../../org/apache/juneau/rest/servlet/RestObject.html#setContext-org.apache.juneau.rest.RestContext-">setContext</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="HtmlBeansResource--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>HtmlBeansResource</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.57">HtmlBeansResource</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getChildDescriptions--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getChildDescriptions</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/rest/beans/ResourceDescriptions.html" title="class in org.apache.juneau.rest.beans">ResourceDescriptions</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.67">getChildDescriptions</a>()</pre>
<div class="block">[HTTP GET /htmlbeans]</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Descriptive links to the child endpoints.</dd>
</dl>
</li>
</ul>
<a name="aTable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aTable</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/dto/html5/Table.html" title="class in org.apache.juneau.dto.html5">Table</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.87">aTable</a>()</pre>
<div class="block">[HTTP GET /htmlbeans/table]</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An example table.</dd>
</dl>
</li>
</ul>
<a name="aDiv--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>aDiv</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/dto/html5/HtmlElement.html" title="class in org.apache.juneau.dto.html5">HtmlElement</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.112">aDiv</a>()</pre>
<div class="block">[HTTP GET /htmlbeans/div]</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An example div tag.</dd>
</dl>
</li>
</ul>
<a name="aForm--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>aForm</h4>
<pre>public&nbsp;<a href="../../../../../org/apache/juneau/dto/html5/Form.html" title="class in org.apache.juneau.dto.html5">Form</a>&nbsp;<a href="../../../../../src-html/org/apache/juneau/examples/rest/HtmlBeansResource.html#line.132">aForm</a>()</pre>
<div class="block">[HTTP GET /htmlbeans/form]</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>An example form tag.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= 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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">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">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/juneau/examples/rest/HelloWorldResource.html" title="class in org.apache.juneau.examples.rest"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/juneau/examples/rest/PhotosResource.html" title="class in org.apache.juneau.examples.rest"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/juneau/examples/rest/HtmlBeansResource.html" target="_top">Frames</a></li>
<li><a href="HtmlBeansResource.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>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2016&#x2013;2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>