| <!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>JsonSchemaResource (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="JsonSchemaResource (Apache Juneau 9.0.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":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/dto/DtoExamples.html" title="class in org.apache.juneau.examples.rest.dto"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/juneau/examples/rest/dto/JsonSchemaResource.html" target="_top">Frames</a></li> |
| <li><a href="JsonSchemaResource.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.dto</div> |
| <h2 title="Class JsonSchemaResource" class="title">Class JsonSchemaResource</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>javax.servlet.GenericServlet</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.servlet.http.HttpServlet</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet">org.apache.juneau.rest.servlet.RestServlet</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet">org.apache.juneau.rest.servlet.BasicRestServlet</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.juneau.examples.rest.dto.JsonSchemaResource</li> |
| </ul> |
| </li> |
| </ul> |
| </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="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, javax.servlet.Servlet, javax.servlet.ServletConfig, <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><a href="../../../../../../org/apache/juneau/annotation/Marshalled.html" title="annotation in org.apache.juneau.annotation">@Marshalled</a>(<a href="../../../../../../org/apache/juneau/annotation/Marshalled.html#on--">on</a>="Schema", |
| <a href="../../../../../../org/apache/juneau/annotation/Marshalled.html#example--">example</a>="$F{JsonSchemaResource_example.json}") |
| public class <a href="../../../../../../src-html/org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#line.63">JsonSchemaResource</a> |
| extends <a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet">BasicRestServlet</a></pre> |
| <div class="block">Sample resource that shows how to serialize JSON-Schema documents. |
| |
| <ul class='seealso'> |
| <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/dto/JsonSchemaResource.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"> </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/dto/JsonSchemaResource.html#JsonSchemaResource--">JsonSchemaResource</a></span>()</code> </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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#get--">get</a></span>()</code> |
| <div class="block">[HTTP GET /dto/jsonSchema] |
| Get the JSON-Schema document.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#init--">init</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../../org/apache/juneau/dto/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#put-org.apache.juneau.dto.jsonschema.JsonSchema-">put</a></span>(<a href="../../../../../../org/apache/juneau/dto/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a> schema)</code> |
| <div class="block">[HTTP PUT /dto/jsonSchema] |
| Overwrite the JSON-Schema document</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.juneau.rest.servlet.BasicRestServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.juneau.rest.servlet.<a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html" title="class in org.apache.juneau.rest.servlet">BasicRestServlet</a></h3> |
| <code><a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#error--">error</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getFavIcon--">getFavIcon</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getHtdoc-java.lang.String-java.util.Locale-">getHtdoc</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.html#getStats-org.apache.juneau.rest.RestRequest-">getStats</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/BasicRestServlet.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.RestServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.juneau.rest.servlet.<a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html" title="class in org.apache.juneau.rest.servlet">RestServlet</a></h3> |
| <code><a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#destroy--">destroy</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#doLog-java.util.logging.Level-java.lang.Throwable-java.util.function.Supplier-">doLog</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getContext--">getContext</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getPath--">getPath</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getRequest--">getRequest</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#getResponse--">getResponse</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#init-javax.servlet.ServletConfig-">init</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.util.logging.Level-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#log-java.util.logging.Level-java.lang.Throwable-java.lang.String-java.lang.Object...-">log</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#service-javax.servlet.http.HttpServletRequest-javax.servlet.http.HttpServletResponse-">service</a>, <a href="../../../../../../org/apache/juneau/rest/servlet/RestServlet.html#setContext-org.apache.juneau.rest.RestContext-">setContext</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.http.HttpServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.http.HttpServlet</h3> |
| <code>doDelete, doGet, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.javax.servlet.GenericServlet"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class javax.servlet.GenericServlet</h3> |
| <code>getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, log, log</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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="JsonSchemaResource--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JsonSchemaResource</h4> |
| <pre>public <a href="../../../../../../src-html/org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#line.63">JsonSchemaResource</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="init--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>init</h4> |
| <pre>public void <a href="../../../../../../src-html/org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#line.69">init</a>()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>init</code> in class <code>javax.servlet.GenericServlet</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="get--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>get</h4> |
| <pre>public <a href="../../../../../../org/apache/juneau/dto/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a> <a href="../../../../../../src-html/org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#line.99">get</a>()</pre> |
| <div class="block">[HTTP GET /dto/jsonSchema] |
| Get the JSON-Schema document.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The JSON-Schema document.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="put-org.apache.juneau.dto.jsonschema.JsonSchema-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>put</h4> |
| <pre>public <a href="../../../../../../org/apache/juneau/dto/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a> <a href="../../../../../../src-html/org/apache/juneau/examples/rest/dto/JsonSchemaResource.html#line.114">put</a>(<a href="../../../../../../org/apache/juneau/http/annotation/Content.html" title="annotation in org.apache.juneau.http.annotation">@Content</a> |
| <a href="../../../../../../org/apache/juneau/dto/jsonschema/JsonSchema.html" title="class in org.apache.juneau.dto.jsonschema">JsonSchema</a> schema)</pre> |
| <div class="block">[HTTP PUT /dto/jsonSchema] |
| Overwrite the JSON-Schema document</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>schema</code> - The new schema document.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The updated schema document.</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/dto/DtoExamples.html" title="class in org.apache.juneau.examples.rest.dto"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/juneau/examples/rest/dto/JsonSchemaResource.html" target="_top">Frames</a></li> |
| <li><a href="JsonSchemaResource.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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 © 2016–2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |