http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 index 0b324d1..f232c56 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ParameterInfo.html @@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab"; <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.65">ParameterInfo</a> +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.76">ParameterInfo</a> extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre> <div class="block">Describes a single operation parameter. <p> @@ -122,7 +122,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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. + <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. @@ -130,18 +131,27 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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). + 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>): + 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. + <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>. + 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> @@ -149,7 +159,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <h6 class='topic'>Additional Information</h6> <ul class='doctree'> - <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a> + <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects + (org.apache.juneau.dto)</a> <ul> <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a> </ul> @@ -651,7 +662,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockListLast"> <li class="blockList"> <h4>ParameterInfo</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.65">ParameterInfo</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ParameterInfo.html#line.76">ParameterInfo</a>()</pre> </li> </ul> </li> @@ -668,7 +679,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>strict</h4> -<pre>protected <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.96">strict</a>()</pre> +<pre>protected <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.107">strict</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html#strict--">SwaggerElement</a></code></span></div> <div class="block">Sets strict mode on this bean.</div> <dl> @@ -685,13 +696,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.112">getName</a>()</pre> +<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.126">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 class="doclink" href="http://swagger.io/specification/#pathsObject";>Paths Object</a>. - See <a class="doclink" href="http://swagger.io/specification/#pathTemplating";>Path Templating</a> for further information. + 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 class="doclink" + href="http://swagger.io/specification/#pathsObject";>Paths Object</a>. + See <a class="doclink" 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> @@ -705,13 +719,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.128">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> +<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.145">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 class="doclink" href="http://swagger.io/specification/#pathsObject";>Paths Object</a>. - See <a class="doclink" href="http://swagger.io/specification/#pathTemplating";>Path Templating</a> for further information. + 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 class="doclink" + href="http://swagger.io/specification/#pathsObject";>Paths Object</a>. + See <a class="doclink" 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> @@ -727,7 +744,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>name</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.140">name</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> +<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.157">name</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -743,7 +760,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.152">getIn</a>()</pre> +<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.169">getIn</a>()</pre> <div class="block">Bean property getter: <property>in</property>. <p> Required. The location of the parameter. @@ -760,7 +777,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.165">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> +<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.182">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. @@ -779,7 +796,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>in</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.180">in</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> +<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.199">in</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setIn-java.lang.String-"><code>setIn(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -795,15 +812,17 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.193">getDescription</a>()</pre> +<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.214">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 class="doclink" href="https://help.github.com/articles/github-flavored-markdown";>GFM syntax</a> can be used for rich text representation.</div> + <a class="doclink" 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> +<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> @@ -813,12 +832,13 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.207">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> +<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.229">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 class="doclink" href="https://help.github.com/articles/github-flavored-markdown";>GFM syntax</a> can be used for rich text representation.</div> + <a class="doclink" 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> @@ -833,7 +853,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>description</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.218">description</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> +<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.240">description</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -849,11 +869,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.231">getRequired</a>()</pre> +<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.254">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>. + 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> @@ -867,11 +888,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.245">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> +<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.269">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>. + 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> @@ -887,7 +909,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>required</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.256">required</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> +<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.280">required</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setRequired-java.lang.Boolean-"><code>setRequired(Boolean)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -903,7 +925,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.267">getSchema</a>()</pre> +<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.291">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> @@ -919,7 +941,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.279">setSchema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre> +<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.303">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> @@ -937,7 +959,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>schema</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.290">schema</a>(<a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a> schema)</pre> +<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.314">schema</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setSchema-org.apache.juneau.dto.swagger.SchemaInfo-"><code>setSchema(SchemaInfo)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -953,13 +975,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.304">getType</a>()</pre> +<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.331">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> + 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> @@ -972,13 +997,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.319">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> +<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">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> + 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> @@ -993,7 +1021,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>type</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.332">type</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> +<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.364">type</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setType-java.lang.String-"><code>setType(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1009,11 +1037,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.344">getFormat</a>()</pre> +<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.377">getFormat</a>()</pre> <div class="block">Bean property getter: <property>format</property>. <p> The extending format for the previously mentioned type. - See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat";>Data Type Formats</a> for further details.</div> + See <a class="doclink" 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> @@ -1026,11 +1055,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.357">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> +<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.391">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 class="doclink" href="http://swagger.io/specification/#dataTypeFormat";>Data Type Formats</a> for further details.</div> + See <a class="doclink" 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> @@ -1045,7 +1075,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>format</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.368">format</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> +<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.402">format</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setFormat-java.lang.String-"><code>setFormat(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1061,15 +1091,17 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.381">getAllowEmptyValue</a>()</pre> +<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.417">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. + 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> +<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> @@ -1079,11 +1111,12 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.395">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> +<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.432">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. + 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> @@ -1099,7 +1132,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>allowEmptyValue</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.406">allowEmptyValue</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> +<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.443">allowEmptyValue</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setAllowEmptyValue-java.lang.Boolean-"><code>setAllowEmptyValue(Boolean)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1115,7 +1148,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.418">getItems</a>()</pre> +<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.455">getItems</a>()</pre> <div class="block">Bean property getter: <property>items</property>. <p> Required if <code>type</code> is <js>"array"</js>. @@ -1132,7 +1165,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.431">setItems</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> items)</pre> +<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.468">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>. @@ -1151,7 +1184,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>items</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.442">items</a>(<a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a> items)</pre> +<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">items</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setItems-org.apache.juneau.dto.swagger.Items-"><code>setItems(Items)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1167,7 +1200,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.465">getCollectionFormat</a>()</pre> +<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.504">getCollectionFormat</a>()</pre> <div class="block">Bean property getter: <property>collectionFormat</property>. <p> Determines the format of the array if type array is used. @@ -1178,14 +1211,16 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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>. + <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> +<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> @@ -1195,7 +1230,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.489">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> +<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.529">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. @@ -1206,7 +1241,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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>. + <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> @@ -1225,7 +1261,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>collectionFormat</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.502">collectionFormat</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> +<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.542">collectionFormat</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setCollectionFormat-java.lang.String-"><code>setCollectionFormat(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1241,12 +1277,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.516">getDefault</a>()</pre> +<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.558">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. + 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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101";>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. + See <a class="doclink" 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> @@ -1260,12 +1298,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.531">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> +<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">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. + 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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor101";>http://json-schema.org/latest/json-schema-validation.html#anchor101</a>. + See <a class="doclink" 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> @@ -1281,7 +1321,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>_default</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.542">_default</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> +<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.586">_default</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setDefault-java.lang.Object-"><code>setDefault(Object)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1297,10 +1337,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.553">getMaximum</a>()</pre> +<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.598">getMaximum</a>()</pre> <div class="block">Bean property getter: <property>maximum</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17";>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> + See <a class="doclink" 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> @@ -1313,10 +1354,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.565">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> +<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.611">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17";>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> + See <a class="doclink" 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> @@ -1331,7 +1373,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>maximum</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.576">maximum</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> +<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.622">maximum</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMaximum-java.lang.Number-"><code>setMaximum(Number)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1347,13 +1389,15 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.587">getExclusiveMaximum</a>()</pre> +<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.635">getExclusiveMaximum</a>()</pre> <div class="block">Bean property getter: <property>exclusiveMaximum</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17";>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> + See <a class="doclink" 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> +<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> @@ -1363,10 +1407,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.599">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> +<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.648">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor17";>http://json-schema.org/latest/json-schema-validation.html#anchor17</a>.</div> + See <a class="doclink" 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> @@ -1381,7 +1426,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>exclusiveMaximum</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.610">exclusiveMaximum</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> +<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.659">exclusiveMaximum</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setExclusiveMaximum-java.lang.Boolean-"><code>setExclusiveMaximum(Boolean)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1397,10 +1442,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.621">getMinimum</a>()</pre> +<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.671">getMinimum</a>()</pre> <div class="block">Bean property getter: <property>minimum</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21";>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> + See <a class="doclink" 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> @@ -1413,10 +1459,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.633">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> +<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.684">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21";>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> + See <a class="doclink" 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> @@ -1431,7 +1478,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>minimum</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.644">minimum</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> +<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.695">minimum</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMinimum-java.lang.Number-"><code>setMinimum(Number)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1447,13 +1494,15 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.655">getExclusiveMinimum</a>()</pre> +<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.708">getExclusiveMinimum</a>()</pre> <div class="block">Bean property getter: <property>exclusiveMinimum</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21";>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> + See <a class="doclink" 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> +<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> @@ -1463,10 +1512,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.667">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> +<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.721">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor21";>http://json-schema.org/latest/json-schema-validation.html#anchor21</a>.</div> + See <a class="doclink" 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> @@ -1481,7 +1531,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>exclusiveMinimum</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.678">exclusiveMinimum</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> +<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.732">exclusiveMinimum</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setExclusiveMinimum-java.lang.Boolean-"><code>setExclusiveMinimum(Boolean)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1497,10 +1547,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.689">getMaxLength</a>()</pre> +<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.744">getMaxLength</a>()</pre> <div class="block">Bean property getter: <property>maxLength</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26";>http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div> + See <a class="doclink" 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> @@ -1513,10 +1564,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.701">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> +<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.757">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor26";>http://json-schema.org/latest/json-schema-validation.html#anchor26</a>.</div> + See <a class="doclink" 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> @@ -1531,7 +1583,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>maxLength</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.712">maxLength</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> +<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.768">maxLength</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMaxLength-java.lang.Integer-"><code>setMaxLength(Integer)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1547,10 +1599,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.723">getMinLength</a>()</pre> +<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.780">getMinLength</a>()</pre> <div class="block">Bean property getter: <property>minLength</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29";>http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div> + See <a class="doclink" 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> @@ -1563,10 +1616,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.735">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> +<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.793">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor29";>http://json-schema.org/latest/json-schema-validation.html#anchor29</a>.</div> + See <a class="doclink" 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> @@ -1581,7 +1635,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>minLength</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.746">minLength</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> +<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.804">minLength</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setMinLength-java.lang.Integer-"><code>setMinLength(Integer)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1597,10 +1651,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.757">getPattern</a>()</pre> +<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.816">getPattern</a>()</pre> <div class="block">Bean property getter: <property>pattern</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33";>http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div> + See <a class="doclink" 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> @@ -1613,10 +1668,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.769">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> +<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.829">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor33";>http://json-schema.org/latest/json-schema-validation.html#anchor33</a>.</div> + See <a class="doclink" 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> @@ -1631,7 +1687,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>pattern</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.780">pattern</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> +<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.840">pattern</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">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html#setPattern-java.lang.String-"><code>setPattern(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -1647,10 +1703,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.791">getMaxItems</a>()</pre> +<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.852">getMaxItems</a>()</pre> <div class="block">Bean property getter: <property>maxItems</property>. <p> - See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42";>http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div> + See <a class="doclink" 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> @@ -1663,10 +1720,11 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <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.803">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> +<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.865">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 class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor42";>http://json-schema.org/latest/json-schema-validation.html#anchor42</a>.</div> + See <a class="doclink" 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> @@ -1681,7 +1739,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>maxItems</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.814">maxItems</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">Integ
<TRUNCATED>
