http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html index 41b54d4..0d8e1a1 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html @@ -44,7 +44,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/dto/cognos/package-summary.html">Prev Package</a></li> -<li><a href="../../../../../org/apache/juneau/encoders/package-summary.html">Next Package</a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/jsonschema/package-summary.html" target="_top">Frames</a></li> @@ -590,7 +590,7 @@ * Replaces the schema document with the specified content, and then mirrors it as the response. */</jd> <ja>@RestMethod</ja>(name=<js>"PUT"</js>, path=<js>"/"</js>) - <jk>public</jk> Schema setSchema(<ja>@Content</ja> Schema schema) <jk>throws</jk> Exception { + <jk>public</jk> Schema setSchema(<ja>@Body</ja> Schema schema) <jk>throws</jk> Exception { <jk>this</jk>.<jf>schema</jf> = schema; <jk>return</jk> <jk>this</jk>.<jf>schema</jf>; } @@ -679,7 +679,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/dto/cognos/package-summary.html">Prev Package</a></li> -<li><a href="../../../../../org/apache/juneau/encoders/package-summary.html">Next Package</a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/jsonschema/package-summary.html" target="_top">Frames</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-tree.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-tree.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-tree.html index 42e8e13..3b34c84 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-tree.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-tree.html @@ -44,7 +44,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/dto/cognos/package-tree.html">Prev</a></li> -<li><a href="../../../../../org/apache/juneau/encoders/package-tree.html">Next</a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/package-tree.html">Next</a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/jsonschema/package-tree.html" target="_top">Frames</a></li> @@ -164,7 +164,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/juneau/dto/cognos/package-tree.html">Prev</a></li> -<li><a href="../../../../../org/apache/juneau/encoders/package-tree.html">Next</a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/package-tree.html">Next</a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/juneau/dto/jsonschema/package-tree.html" target="_top">Frames</a></li> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html new file mode 100644 index 0000000..e23221d --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html @@ -0,0 +1,432 @@ +<!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>Contact (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</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="Contact (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/Contact.html">Use</a></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>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Contact.html" target="_top">Frames</a></li> +<li><a href="Contact.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.dto.swagger</div> +<h2 title="Class Contact" class="title">Class Contact</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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>org.apache.juneau.dto.swagger.Contact</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="name,url,email") +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.32">Contact</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Contact information for the exposed API. + + <h6 class='topic'>Example:</h6> + <p class='bcode'> + { + <js>"name"</js>: <js>"API Support"</js>, + <js>"url"</js>: <js>"http://www.swagger.io/support";</js>, + <js>"email"</js>: <js>"[email protected]"</js> + } + </p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>james.bognar</dd> +</dl> +</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/dto/swagger/Contact.html#Contact--">Contact</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#create--">create</a></span>()</code> +<div class="block">Convenience method for creating a new Contact object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#getEmail--">getEmail</a></span>()</code> +<div class="block">Bean property getter: <property>email</property>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#getName--">getName</a></span>()</code> +<div class="block">Bean property getter: <property>name</property>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#getUrl--">getUrl</a></span>()</code> +<div class="block">Bean property getter: <property>url</property>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setEmail-java.lang.String-">setEmail</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</code> +<div class="block">Bean property setter: <property>email</property>.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Bean property setter: <property>name</property>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setUrl-java.lang.String-">setUrl</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</code> +<div class="block">Bean property setter: <property>url</property>.</div> +</td> +</tr> +</table> +<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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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="Contact--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>Contact</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.32">Contact</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="create--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.43">create</a>()</pre> +<div class="block">Convenience method for creating a new Contact object.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new Contact object.</dd> +</dl> +</li> +</ul> +<a name="getName--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.54">getName</a>()</pre> +<div class="block">Bean property getter: <property>name</property>. + <p> + The identifying name of the contact person/organization.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setName-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setName</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.66">setName</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Bean property setter: <property>name</property>. + <p> + The identifying name of the contact person/organization.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - The new value for the <property>name</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getUrl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUrl</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.78">getUrl</a>()</pre> +<div class="block">Bean property getter: <property>url</property>. + <p> + The URL pointing to the contact information. MUST be in the format of a URL.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setUrl-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUrl</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.90">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</pre> +<div class="block">Bean property setter: <property>url</property>. + <p> + The URL pointing to the contact information. MUST be in the format of a URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>url</code> - The new value for the <property>url</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getEmail--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEmail</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.102">getEmail</a>()</pre> +<div class="block">Bean property getter: <property>email</property>. + <p> + The email address of the contact person/organization. MUST be in the format of an email address.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>email</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setEmail-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setEmail</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.114">setEmail</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</pre> +<div class="block">Bean property setter: <property>email</property>. + <p> + The email address of the contact person/organization. MUST be in the format of an email address.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>email</code> - The new value for the <property>email</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</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="class-use/Contact.html">Use</a></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>Prev Class</li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/Contact.html" target="_top">Frames</a></li> +<li><a href="Contact.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 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html b/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html new file mode 100644 index 0000000..390660b --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html @@ -0,0 +1,387 @@ +<!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>ExternalDocumentation (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)</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="ExternalDocumentation (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":10,"i2":10,"i3":10,"i4":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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="class-use/ExternalDocumentation.html">Use</a></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/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/ExternalDocumentation.html" target="_top">Frames</a></li> +<li><a href="ExternalDocumentation.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.dto.swagger</div> +<h2 title="Class ExternalDocumentation" class="title">Class ExternalDocumentation</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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>org.apache.juneau.dto.swagger.ExternalDocumentation</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="description,url") +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.31">ExternalDocumentation</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></pre> +<div class="block">Allows referencing an external resource for extended documentation. + + <h6 class='topic'>Example:</h6> + <p class='bcode'> + { + <js>"description"</js>: <js>"Find more info here"</js>, + <js>"url"</js>: <js>"https://swagger.io";</js> + } + </p></div> +<dl> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>james.bognar</dd> +</dl> +</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/dto/swagger/ExternalDocumentation.html#ExternalDocumentation--">ExternalDocumentation</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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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>static <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#create-java.lang.String-">create</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</code> +<div class="block">Convenience method for creating a new ExternalDocumentation object.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#getDescription--">getDescription</a></span>()</code> +<div class="block">Bean property getter: <property>description</property>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#getUrl--">getUrl</a></span>()</code> +<div class="block">Bean property getter: <property>url</property>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#setDescription-java.lang.String-">setDescription</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</code> +<div class="block">Bean property setter: <property>description</property>.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#setUrl-java.lang.String-">setUrl</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</code> +<div class="block">Bean property setter: <property>url</property>.</div> +</td> +</tr> +</table> +<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="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--"; title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-"; title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--"; title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--"; title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--"; title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--"; title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-"; title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/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="ExternalDocumentation--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ExternalDocumentation</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.31">ExternalDocumentation</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="create-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.42">create</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</pre> +<div class="block">Convenience method for creating a new ExternalDocumentation object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>url</code> - Required. The URL for the target documentation. Value MUST be in the format of a URL.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new ExternalDocumentation object.</dd> +</dl> +</li> +</ul> +<a name="getDescription--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDescription</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.53">getDescription</a>()</pre> +<div class="block">Bean property getter: <property>description</property>. + <p> + A short description of the target documentation. GFM syntax can be used for rich text representation.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setDescription-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDescription</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.65">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</pre> +<div class="block">Bean property setter: <property>description</property>. + <p> + A short description of the target documentation. GFM syntax can be used for rich text representation.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>description</code> - The new value for the <property>description</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</dd> +</dl> +</li> +</ul> +<a name="getUrl--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUrl</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.77">getUrl</a>()</pre> +<div class="block">Bean property getter: <property>url</property>. + <p> + Required. The URL for the target documentation. Value MUST be in the format of a URL.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>url</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setUrl-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setUrl</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.89">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> url)</pre> +<div class="block">Bean property setter: <property>url</property>. + <p> + Required. The URL for the target documentation. Value MUST be in the format of a URL.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>url</code> - The new value for the <property>url</property> property on this bean.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>This object (for method chaining).</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="class-use/ExternalDocumentation.html">Use</a></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/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/juneau/dto/swagger/ExternalDocumentation.html" target="_top">Frames</a></li> +<li><a href="ExternalDocumentation.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 <a href="http://www.apache.org/";>Apache</a>. All rights reserved.</small></p> +</body> +</html>
