http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html b/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html new file mode 100644 index 0000000..3c819c5 --- /dev/null +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html @@ -0,0 +1,1524 @@ +<!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>ParameterInfo (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="ParameterInfo (Apache Juneau (incubating) 6.0.0-incubating-SNAPSHOT)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":9,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10,"i33":10,"i34":10,"i35":10,"i36":10,"i37":10,"i38":10,"i39":10,"i40":10,"i41":10,"i42":10,"i43":10,"i44":10,"i45":10,"i46":10,"i47":10,"i48":10,"i49":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/ParameterInfo.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/Operation.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/ResponseInfo.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/ParameterInfo.html" target="_top">Frames</a></li> +<li><a href="ParameterInfo.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 ParameterInfo" class="title">Class ParameterInfo</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.ParameterInfo</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>="in,name,type,description,required,schema,format,allowEmptyValue,items,collectionFormat,default,maximum,exclusiveMaximum,minimum,exclusiveMinimum,maxLength,minLength,pattern,maxItems,minItems,uniqueItems,enum,multipleOf") +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.56">ParameterInfo</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">Describes a single operation parameter. + <p> + A unique parameter is defined by a combination of a name and location. + <p> + There are five possible parameter types. + <ul> + <li><js>"path"</js> - Used together with Path Templating, where the parameter value is actually part of the operation's URL. + This does not include the host or base path of the API. + For example, in <code>/items/{itemId}</code>, the path parameter is <code>itemId</code>. + <li><js>"query"</js> - Parameters that are appended to the URL. + For example, in <code>/items?id=###</code>, the query parameter is <code>id</code>. + <li><js>"header"</js> - Custom headers that are expected as part of the request. + <li><js>"body"</js> - The payload that's appended to the HTTP request. + Since there can only be one payload, there can only be one body parameter. + The name of the body parameter has no effect on the parameter itself and is used for documentation purposes only. + Since Form parameters are also in the payload, body and form parameters cannot exist together for the same operation. + <li><js>"formData"</js> - Used to describe the payload of an HTTP request when either <code>application/x-www-form-urlencoded</code>, <code>multipart/form-data</code> or both are used as the content type of the request (in Swagger's definition, the consumes property of an operation). + This is the only parameter type that can be used to send files, thus supporting the file type. + Since form parameters are sent in the payload, they cannot be declared together with a body parameter for the same operation. + Form parameters have a different format based on the content-type used (for further details, consult <code>http://www.w3.org/TR/html401/interact/forms.html#h-17.13.4</code>): + <ul> + <li><js>"application/x-www-form-urlencoded"</js> - Similar to the format of Query parameters but as a payload. + For example, <code>foo=1&bar=swagger</code> - both <code>foo</code> and <code>bar</code> are form parameters. + This is normally used for simple parameters that are being transferred. + <li><js>"multipart/form-data"</js> - each parameter takes a section in the payload with an internal header. + For example, for the header <code>Content-Disposition: form-data; name="submit-name"<code> the name of the parameter is <code>submit-name</code>. + This type of form parameters is more commonly used for file transfers. + </ul> + </li> + </ul></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/ParameterInfo.html#ParameterInfo--">ParameterInfo</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><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#addEnum-java.util.Collection-">addEnum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true"; title="class or interface in java.util">Collection</a><<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>> _enum)</code> +<div class="block">Bean property adder: <property>enum</property>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#addEnum-java.lang.Object...-">addEnum</a></span>(<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>... _enum)</code> +<div class="block">Bean property adder: <property>enum</property>.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#create-java.lang.String-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> in, + <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">Convenience method for creating a new Parameter object.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#createStrict-java.lang.String-java.lang.String-">createStrict</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> in, + <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">Same as <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#create-java.lang.String-java.lang.String-"><code>create(String, String)</code></a> except methods will throw runtime exceptions if you attempt + to pass in invalid values per the Swagger spec.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getAllowEmptyValue--">getAllowEmptyValue</a></span>()</code> +<div class="block">Bean property getter: <property>allowEmptyValue</property>.</div> +</td> +</tr> +<tr id="i5" 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/ParameterInfo.html#getCollectionFormat--">getCollectionFormat</a></span>()</code> +<div class="block">Bean property getter: <property>collectionFormat</property>.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><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></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getDefault--">getDefault</a></span>()</code> +<div class="block">Bean property getter: <property>default</property>.</div> +</td> +</tr> +<tr id="i7" 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/ParameterInfo.html#getDescription--">getDescription</a></span>()</code> +<div class="block">Bean property getter: <property>description</property>.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getEnum--">getEnum</a></span>()</code> +<div class="block">Bean property getter: <property>enum</property>.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getExclusiveMaximum--">getExclusiveMaximum</a></span>()</code> +<div class="block">Bean property getter: <property>exclusiveMaximum</property>.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getExclusiveMinimum--">getExclusiveMinimum</a></span>()</code> +<div class="block">Bean property getter: <property>exclusiveMinimum</property>.</div> +</td> +</tr> +<tr id="i11" 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/ParameterInfo.html#getFormat--">getFormat</a></span>()</code> +<div class="block">Bean property getter: <property>format</property>.</div> +</td> +</tr> +<tr id="i12" 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/ParameterInfo.html#getIn--">getIn</a></span>()</code> +<div class="block">Bean property getter: <property>in</property>.</div> +</td> +</tr> +<tr id="i13" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getItems--">getItems</a></span>()</code> +<div class="block">Bean property getter: <property>items</property>.</div> +</td> +</tr> +<tr id="i14" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMaximum--">getMaximum</a></span>()</code> +<div class="block">Bean property getter: <property>maximum</property>.</div> +</td> +</tr> +<tr id="i15" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMaxItems--">getMaxItems</a></span>()</code> +<div class="block">Bean property getter: <property>maxItems</property>.</div> +</td> +</tr> +<tr id="i16" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMaxLength--">getMaxLength</a></span>()</code> +<div class="block">Bean property getter: <property>maxLength</property>.</div> +</td> +</tr> +<tr id="i17" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMinimum--">getMinimum</a></span>()</code> +<div class="block">Bean property getter: <property>minimum</property>.</div> +</td> +</tr> +<tr id="i18" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMinItems--">getMinItems</a></span>()</code> +<div class="block">Bean property getter: <property>minItems</property>.</div> +</td> +</tr> +<tr id="i19" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMinLength--">getMinLength</a></span>()</code> +<div class="block">Bean property getter: <property>minLength</property>.</div> +</td> +</tr> +<tr id="i20" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getMultipleOf--">getMultipleOf</a></span>()</code> +<div class="block">Bean property getter: <property>multipleOf</property>.</div> +</td> +</tr> +<tr id="i21" 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/ParameterInfo.html#getName--">getName</a></span>()</code> +<div class="block">Bean property getter: <property>name</property>.</div> +</td> +</tr> +<tr id="i22" 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/ParameterInfo.html#getPattern--">getPattern</a></span>()</code> +<div class="block">Bean property getter: <property>pattern</property>.</div> +</td> +</tr> +<tr id="i23" class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getRequired--">getRequired</a></span>()</code> +<div class="block">Bean property getter: <property>required</property>.</div> +</td> +</tr> +<tr id="i24" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getSchema--">getSchema</a></span>()</code> +<div class="block">Bean property getter: <property>schema</property>.</div> +</td> +</tr> +<tr id="i25" 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/ParameterInfo.html#getType--">getType</a></span>()</code> +<div class="block">Bean property getter: <property>type</property>.</div> +</td> +</tr> +<tr id="i26" class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#getUniqueItems--">getUniqueItems</a></span>()</code> +<div class="block">Bean property getter: <property>uniqueItems</property>.</div> +</td> +</tr> +<tr id="i27" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setAllowEmptyValue-java.lang.Boolean-">setAllowEmptyValue</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> allowEmptyValue)</code> +<div class="block">Bean property setter: <property>allowEmptyValue</property>.</div> +</td> +</tr> +<tr id="i28" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setCollectionFormat-java.lang.String-">setCollectionFormat</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> collectionFormat)</code> +<div class="block">Bean property setter: <property>collectionFormat</property>.</div> +</td> +</tr> +<tr id="i29" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setDefault-java.lang.Object-">setDefault</a></span>(<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> _default)</code> +<div class="block">Bean property setter: <property>default</property>.</div> +</td> +</tr> +<tr id="i30" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.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="i31" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setEnum-java.util.List-">setEnum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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>> _enum)</code> +<div class="block">Bean property setter: <property>enum</property>.</div> +</td> +</tr> +<tr id="i32" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setExclusiveMaximum-java.lang.Boolean-">setExclusiveMaximum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> exclusiveMaximum)</code> +<div class="block">Bean property setter: <property>exclusiveMaximum</property>.</div> +</td> +</tr> +<tr id="i33" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setExclusiveMinimum-java.lang.Boolean-">setExclusiveMinimum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> exclusiveMinimum)</code> +<div class="block">Bean property setter: <property>exclusiveMinimum</property>.</div> +</td> +</tr> +<tr id="i34" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setFormat-java.lang.String-">setFormat</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> format)</code> +<div class="block">Bean property setter: <property>format</property>.</div> +</td> +</tr> +<tr id="i35" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setIn-java.lang.String-">setIn</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> in)</code> +<div class="block">Bean property setter: <property>in</property>.</div> +</td> +</tr> +<tr id="i36" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setItems-org.apache.juneau.dto.swagger.Items-">setItems</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> items)</code> +<div class="block">Bean property setter: <property>items</property>.</div> +</td> +</tr> +<tr id="i37" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMaximum-java.lang.Number-">setMaximum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> maximum)</code> +<div class="block">Bean property setter: <property>maximum</property>.</div> +</td> +</tr> +<tr id="i38" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMaxItems-java.lang.Integer-">setMaxItems</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> maxItems)</code> +<div class="block">Bean property setter: <property>maxItems</property>.</div> +</td> +</tr> +<tr id="i39" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMaxLength-java.lang.Integer-">setMaxLength</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> maxLength)</code> +<div class="block">Bean property setter: <property>maxLength</property>.</div> +</td> +</tr> +<tr id="i40" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMinimum-java.lang.Number-">setMinimum</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> minimum)</code> +<div class="block">Bean property setter: <property>minimum</property>.</div> +</td> +</tr> +<tr id="i41" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMinItems-java.lang.Integer-">setMinItems</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> minItems)</code> +<div class="block">Bean property setter: <property>minItems</property>.</div> +</td> +</tr> +<tr id="i42" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMinLength-java.lang.Integer-">setMinLength</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> minLength)</code> +<div class="block">Bean property setter: <property>minLength</property>.</div> +</td> +</tr> +<tr id="i43" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMultipleOf-java.lang.Number-">setMultipleOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> multipleOf)</code> +<div class="block">Bean property setter: <property>multipleOf</property>.</div> +</td> +</tr> +<tr id="i44" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.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="i45" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setPattern-java.lang.String-">setPattern</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> pattern)</code> +<div class="block">Bean property setter: <property>pattern</property>.</div> +</td> +</tr> +<tr id="i46" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setRequired-java.lang.Boolean-">setRequired</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> required)</code> +<div class="block">Bean property setter: <property>required</property>.</div> +</td> +</tr> +<tr id="i47" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-">setSchema</a></span>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</code> +<div class="block">Bean property setter: <property>schema</property>.</div> +</td> +</tr> +<tr id="i48" class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setType-java.lang.String-">setType</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> type)</code> +<div class="block">Bean property setter: <property>type</property>.</div> +</td> +</tr> +<tr id="i49" class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setUniqueItems-java.lang.Boolean-">setUniqueItems</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> uniqueItems)</code> +<div class="block">Bean property setter: <property>uniqueItems</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="ParameterInfo--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ParameterInfo</h4> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.56">ParameterInfo</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-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public static <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.99">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> in, + <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">Convenience method for creating a new Parameter object.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - Required. The location of the parameter. + Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.</dd> +<dd><code>name</code> - Required. The name of the parameter. + Parameter names are case sensitive. + If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a href='http://swagger.io/specification/#pathsObject'>Paths Object</a>. + See <a href='http://swagger.io/specification/#pathTemplating'>Path Templating</a> for further information. + For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new Parameter object.</dd> +</dl> +</li> +</ul> +<a name="createStrict-java.lang.String-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>createStrict</h4> +<pre>public static <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.116">createStrict</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> in, + <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">Same as <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#create-java.lang.String-java.lang.String-"><code>create(String, String)</code></a> except methods will throw runtime exceptions if you attempt + to pass in invalid values per the Swagger spec.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - Required. The location of the parameter. + Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.</dd> +<dd><code>name</code> - Required. The name of the parameter. + Parameter names are case sensitive. + If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a href='http://swagger.io/specification/#pathsObject'>Paths Object</a>. + See <a href='http://swagger.io/specification/#pathTemplating'>Path Templating</a> for further information. + For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>A new Parameter 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/ParameterInfo.html#line.136">getName</a>()</pre> +<div class="block">Bean property getter: <property>name</property>. + <p> + Required. The name of the parameter. + Parameter names are case sensitive. + If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a href='http://swagger.io/specification/#pathsObject'>Paths Object</a>. + See <a href='http://swagger.io/specification/#pathTemplating'>Path Templating</a> for further information. + For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.</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/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.152">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> + Required. The name of the parameter. + Parameter names are case sensitive. + If <code>in</code> is <js>"path"</js>, the <code>name</code> field MUST correspond to the associated path segment from the <code>path</code> field in the <a href='http://swagger.io/specification/#pathsObject'>Paths Object</a>. + See <a href='http://swagger.io/specification/#pathTemplating'>Path Templating</a> for further information. + For all other cases, the name corresponds to the parameter name used based on the <code>in</code> property.</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="getIn--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIn</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/ParameterInfo.html#line.166">getIn</a>()</pre> +<div class="block">Bean property getter: <property>in</property>. + <p> + Required. The location of the parameter. + Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setIn-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setIn</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.179">setIn</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> in)</pre> +<div class="block">Bean property setter: <property>in</property>. + <p> + Required. The location of the parameter. + Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>in</code> - The new value for the <property>in</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="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/ParameterInfo.html#line.197">getDescription</a>()</pre> +<div class="block">Bean property getter: <property>description</property>. + <p> + A brief description of the parameter. + This could contain examples of use. + <a href='https://help.github.com/articles/github-flavored-markdown'>GFM syntax</a> 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/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.211">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 brief description of the parameter. + This could contain examples of use. + <a href='https://help.github.com/articles/github-flavored-markdown'>GFM syntax</a> 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="getRequired--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRequired</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.225">getRequired</a>()</pre> +<div class="block">Bean property getter: <property>required</property>. + <p> + Determines whether this parameter is mandatory. + If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>. + Otherwise, the property MAY be included and its default value is <jk>false</jk>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setRequired-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRequired</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.239">setRequired</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> required)</pre> +<div class="block">Bean property setter: <property>required</property>. + <p> + Determines whether this parameter is mandatory. + If the parameter is <code>in</code> <js>"path"</js>, this property is required and its value MUST be <jk>true</jk>. + Otherwise, the property MAY be included and its default value is <jk>false</jk>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>required</code> - The new value for the <property>required</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="getSchema--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSchema</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.251">getSchema</a>()</pre> +<div class="block">Bean property getter: <property>schema</property>. + <p> + Required. The schema defining the type used for the body parameter.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setSchema-org.apache.juneau.dto.swagger.SchemaInfo-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSchema</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.263">setSchema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre> +<div class="block">Bean property setter: <property>schema</property>. + <p> + Required. The schema defining the type used for the body parameter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>schema</code> - The new value for the <property>schema</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="getType--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getType</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/ParameterInfo.html#line.278">getType</a>()</pre> +<div class="block">Bean property getter: <property>type</property>. + <p> + Required. The type of the parameter. + Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). + The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>. + If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>, <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code> <js>"formData"</js>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setType-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.293">setType</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> type)</pre> +<div class="block">Bean property setter: <property>type</property>. + <p> + Required. The type of the parameter. + Since the parameter is not located at the request body, it is limited to simple types (that is, not an object). + The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, <js>"array"</js> or <js>"file"</js>. + If type is <js>"file"</js>, the <code>consumes</code> MUST be either <js>"multipart/form-data"</js>, <js>"application/x-www-form-urlencoded"</js> or both and the parameter MUST be <code>in</code> <js>"formData"</js>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>type</code> - The new value for the <property>type</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="getFormat--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFormat</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/ParameterInfo.html#line.308">getFormat</a>()</pre> +<div class="block">Bean property getter: <property>format</property>. + <p> + The extending format for the previously mentioned type. + See <a href='http://swagger.io/specification/#dataTypeFormat'>Data Type Formats</a> for further details.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setFormat-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFormat</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.321">setFormat</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> format)</pre> +<div class="block">Bean property setter: <property>format</property>. + <p> + The extending format for the previously mentioned type. + See <a href='http://swagger.io/specification/#dataTypeFormat'>Data Type Formats</a> for further details.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>format</code> - The new value for the <property>format</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="getAllowEmptyValue--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowEmptyValue</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.335">getAllowEmptyValue</a>()</pre> +<div class="block">Bean property getter: <property>allowEmptyValue</property>. + <p> + Sets the ability to pass empty-valued parameters. + This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value. + Default value is <jk>false</jk>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setAllowEmptyValue-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllowEmptyValue</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.349">setAllowEmptyValue</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> allowEmptyValue)</pre> +<div class="block">Bean property setter: <property>allowEmptyValue</property>. + <p> + Sets the ability to pass empty-valued parameters. + This is valid only for either <code>query</code> or <code>formData</code> parameters and allows you to send a parameter with a name only or an empty value. + Default value is <jk>false</jk>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>allowEmptyValue</code> - The new value for the <property>allowEmptyValue</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="getItems--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getItems</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.362">getItems</a>()</pre> +<div class="block">Bean property getter: <property>items</property>. + <p> + Required if <code>type</code> is <js>"array"</js>. + Describes the type of items in the array.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setItems-org.apache.juneau.dto.swagger.Items-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setItems</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.375">setItems</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> items)</pre> +<div class="block">Bean property setter: <property>items</property>. + <p> + Required if <code>type</code> is <js>"array"</js>. + Describes the type of items in the array.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>items</code> - The new value for the <property>items</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="getCollectionFormat--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCollectionFormat</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/ParameterInfo.html#line.399">getCollectionFormat</a>()</pre> +<div class="block">Bean property getter: <property>collectionFormat</property>. + <p> + Determines the format of the array if type array is used. + <p> + Possible values are: + <ul> + <li><code>csv</code> - comma separated values <code>foo,bar</code>. + <li><code>ssv</code> - space separated values <code>foo bar</code>. + <li><code>tsv</code> - tab separated values <code>foo\tbar</code>. + <li><code>pipes</code> - pipe separated values <code>foo|bar</code>. + <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single instance <code>foo=bar&foo=baz</code>. + This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>. + </ul> + <p> + Default value is <code>csv</code>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setCollectionFormat-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCollectionFormat</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.423">setCollectionFormat</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> collectionFormat)</pre> +<div class="block">Bean property setter: <property>collectionFormat</property>. + <p> + Determines the format of the array if type array is used. + <p> + Possible values are: + <ul> + <li><code>csv</code> - comma separated values <code>foo,bar</code>. + <li><code>ssv</code> - space separated values <code>foo bar</code>. + <li><code>tsv</code> - tab separated values <code>foo\tbar</code>. + <li><code>pipes</code> - pipe separated values <code>foo|bar</code>. + <li><code>multi</code> - corresponds to multiple parameter instances instead of multiple values for a single instance <code>foo=bar&foo=baz</code>. + This is valid only for parameters <code>in</code> <js>"query"</js> or <js>"formData"</js>. + </ul> + <p> + Default value is <code>csv</code>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>collectionFormat</code> - The new value for the <property>collectionFormat</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="getDefault--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefault</h4> +<pre>public <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> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.440">getDefault</a>()</pre> +<div class="block">Bean property getter: <property>default</property>. + <p> + Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js> to control the number of results per page might default to 100 if not supplied by the client in the request. + (Note: <js>"default"</js> has no meaning for required parameters.) + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor101'>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. + Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setDefault-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDefault</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.455">setDefault</a>(<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> _default)</pre> +<div class="block">Bean property setter: <property>default</property>. + <p> + Declares the value of the parameter that the server will use if none is provided, for example a <js>"count"</js> to control the number of results per page might default to 100 if not supplied by the client in the request. + (Note: <js>"default"</js> has no meaning for required parameters.) + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor101'>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. + Unlike JSON Schema this value MUST conform to the defined <code>type</code> for this parameter.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>_default</code> - The new value for the <property>default</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="getMaximum--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaximum</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.467">getMaximum</a>()</pre> +<div class="block">Bean property getter: <property>maximum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor17'>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMaximum-java.lang.Number-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaximum</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.479">setMaximum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> maximum)</pre> +<div class="block">Bean property setter: <property>maximum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor17'>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maximum</code> - The new value for the <property>maximum</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="getExclusiveMaximum--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveMaximum</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.491">getExclusiveMaximum</a>()</pre> +<div class="block">Bean property getter: <property>exclusiveMaximum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor17'>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setExclusiveMaximum-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExclusiveMaximum</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.503">setExclusiveMaximum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> exclusiveMaximum)</pre> +<div class="block">Bean property setter: <property>exclusiveMaximum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor17'>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>exclusiveMaximum</code> - The new value for the <property>exclusiveMaximum</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="getMinimum--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinimum</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.515">getMinimum</a>()</pre> +<div class="block">Bean property getter: <property>minimum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor21'>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMinimum-java.lang.Number-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinimum</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.527">setMinimum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Number.html?is-external=true"; title="class or interface in java.lang">Number</a> minimum)</pre> +<div class="block">Bean property setter: <property>minimum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor21'>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>minimum</code> - The new value for the <property>minimum</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="getExclusiveMinimum--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveMinimum</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.539">getExclusiveMinimum</a>()</pre> +<div class="block">Bean property getter: <property>exclusiveMinimum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor21'>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setExclusiveMinimum-java.lang.Boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExclusiveMinimum</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.551">setExclusiveMinimum</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> exclusiveMinimum)</pre> +<div class="block">Bean property setter: <property>exclusiveMinimum</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor21'>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>exclusiveMinimum</code> - The new value for the <property>exclusiveMinimum</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="getMaxLength--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxLength</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.563">getMaxLength</a>()</pre> +<div class="block">Bean property getter: <property>maxLength</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor26'>http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMaxLength-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxLength</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.575">setMaxLength</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> maxLength)</pre> +<div class="block">Bean property setter: <property>maxLength</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor26'>http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxLength</code> - The new value for the <property>maxLength</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="getMinLength--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinLength</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.587">getMinLength</a>()</pre> +<div class="block">Bean property getter: <property>minLength</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor29'>http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMinLength-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinLength</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.599">setMinLength</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> minLength)</pre> +<div class="block">Bean property setter: <property>minLength</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor29'>http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>minLength</code> - The new value for the <property>minLength</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="getPattern--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPattern</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/ParameterInfo.html#line.611">getPattern</a>()</pre> +<div class="block">Bean property getter: <property>pattern</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor33'>http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setPattern-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPattern</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.623">setPattern</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> pattern)</pre> +<div class="block">Bean property setter: <property>pattern</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor33'>http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>pattern</code> - The new value for the <property>pattern</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="getMaxItems--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxItems</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.635">getMaxItems</a>()</pre> +<div class="block">Bean property getter: <property>maxItems</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor42'>http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMaxItems-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxItems</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.647">setMaxItems</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> maxItems)</pre> +<div class="block">Bean property setter: <property>maxItems</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor42'>http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxItems</code> - The new value for the <property>maxItems</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="getMinItems--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMinItems</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.659">getMinItems</a>()</pre> +<div class="block">Bean property getter: <property>minItems</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor45'>http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a name="setMinItems-java.lang.Integer-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMinItems</h4> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.671">setMinItems</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> minItems)</pre> +<div class="block">Bean property setter: <property>minItems</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor45'>http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>minItems</code> - The new value for the <property>minItems</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="getUniqueItems--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUniqueItems</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Boolean.html?is-external=true"; title="class or interface in java.lang">Boolean</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.683">getUniqueItems</a>()</pre> +<div class="block">Bean property getter: <property>uniqueItems</property>. + <p> + See <a href='http://json-schema.org/latest/json-schema-validation.html#anchor49'>http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +</dl> +</li> +</ul> +<a
<TRUNCATED>
