You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@juneau.apache.org by ja...@apache.org on 2017/06/26 00:41:30 UTC
[15/23] incubator-juneau git commit: Clean up javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
index 692ad34..d7c6260 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ParameterInfo.java
@@ -26,7 +26,8 @@ import org.apache.juneau.json.*;
* <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.
@@ -34,18 +35,27 @@ import org.apache.juneau.json.*;
* <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>
@@ -53,7 +63,8 @@ import org.apache.juneau.json.*;
*
* <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>
@@ -103,8 +114,11 @@ public class ParameterInfo extends SwaggerElement {
* <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.
*
* @return The value of the <property>name</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -118,8 +132,11 @@ public class ParameterInfo extends SwaggerElement {
* <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.
*
* @param name The new value for the <property>name</property> property on this bean.
@@ -164,7 +181,9 @@ public class ParameterInfo extends SwaggerElement {
*/
public ParameterInfo setIn(String in) {
if (isStrict() && ! contains(in, VALID_IN))
- throw new RuntimeException("Invalid value passed in to setIn(String). Value='"+in+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_IN));
+ throw new RuntimeException(
+ "Invalid value passed in to setIn(String). Value='"+in+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_IN));
this.in = in;
if ("path".equals(in))
required = true;
@@ -186,9 +205,11 @@ public class ParameterInfo extends SwaggerElement {
* <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.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -199,7 +220,8 @@ public class ParameterInfo extends SwaggerElement {
* <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.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -223,7 +245,8 @@ public class ParameterInfo extends SwaggerElement {
* 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>.
*
* @return The value of the <property>required</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -236,7 +259,8 @@ public class ParameterInfo extends SwaggerElement {
* 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>.
*
* @param required The new value for the <property>required</property> property on this bean.
@@ -296,8 +320,11 @@ public class ParameterInfo extends SwaggerElement {
* <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>.
+ * 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>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -310,15 +337,20 @@ public class ParameterInfo extends SwaggerElement {
* <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>.
+ * 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>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public ParameterInfo setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -337,7 +369,8 @@ public class ParameterInfo extends SwaggerElement {
* 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.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -349,7 +382,8 @@ public class ParameterInfo extends SwaggerElement {
* 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.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -373,10 +407,12 @@ public class ParameterInfo extends SwaggerElement {
* 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>.
*
- * @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>allowEmptyValue</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getAllowEmptyValue() {
return allowEmptyValue;
@@ -386,7 +422,8 @@ public class ParameterInfo extends SwaggerElement {
* 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>.
*
* @param allowEmptyValue The new value for the <property>allowEmptyValue</property> property on this bean.
@@ -454,13 +491,15 @@ public class ParameterInfo extends SwaggerElement {
* <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>.
*
- * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>collectionFormat</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getCollectionFormat() {
return collectionFormat;
@@ -477,7 +516,8 @@ public class ParameterInfo extends SwaggerElement {
* <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>
@@ -506,9 +546,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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.
*
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -520,9 +562,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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.
*
* @param _default The new value for the <property>default</property> property on this bean.
@@ -546,7 +590,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>maximum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -557,7 +602,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param maximum The new value for the <property>maximum</property> property on this bean.
* @return This object (for method chaining).
@@ -580,9 +626,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk>
+ * if it is not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -591,7 +639,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param exclusiveMaximum The new value for the <property>exclusiveMaximum</property> property on this bean.
* @return This object (for method chaining).
@@ -614,7 +663,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>minimum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -625,7 +675,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param minimum The new value for the <property>minimum</property> property on this bean.
* @return This object (for method chaining).
@@ -648,9 +699,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -659,7 +712,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param exclusiveMinimum The new value for the <property>exclusiveMinimum</property> property on this bean.
* @return This object (for method chaining).
@@ -682,7 +736,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>maxLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -693,7 +748,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param maxLength The new value for the <property>maxLength</property> property on this bean.
* @return This object (for method chaining).
@@ -716,7 +772,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>minLength</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -727,7 +784,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param minLength The new value for the <property>minLength</property> property on this bean.
* @return This object (for method chaining).
@@ -750,7 +808,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>pattern</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -761,7 +820,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param pattern The new value for the <property>pattern</property> property on this bean.
* @return This object (for method chaining).
@@ -784,7 +844,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @return The value of the <property>maxItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -795,7 +856,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* 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>.
+ * 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>.
*
* @param maxItems The new value for the <property>maxItems</property> property on this bean.
* @return This object (for method chaining).
@@ -818,7 +880,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @return The value of the <property>minItems</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -829,7 +892,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>minItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor45">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor45</a>.
*
* @param minItems The new value for the <property>minItems</property> property on this bean.
* @return This object (for method chaining).
@@ -852,9 +916,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -863,7 +929,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>uniqueItems</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor49">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor49</a>.
*
* @param uniqueItems The new value for the <property>uniqueItems</property> property on this bean.
* @return This object (for method chaining).
@@ -886,7 +953,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @return The value of the <property>enum</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -897,7 +965,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new value for the <property>enum</property> property on this bean.
* @return This object (for method chaining).
@@ -910,7 +979,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor76">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor76</a>.
*
* @param _enum The new values to add to the <property>enum</property> property on this bean.
* These can either be individual objects or {@link Collection Collections} of objects.
@@ -946,7 +1016,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @return The value of the <property>multipleOf</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -957,7 +1028,8 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>multipleOf</property>.
* <p>
- * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
+ * See <a class="doclink" href="http://json-schema.org/latest/json-schema-validation.html#anchor14">
+ * http://json-schema.org/latest/json-schema-validation.html#anchor14</a>.
*
* @param multipleOf The new value for the <property>multipleOf</property> property on this bean.
* @return This object (for method chaining).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
index bc9ac0b..4bc5236 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ResponseInfo.java
@@ -34,7 +34,8 @@ import org.apache.juneau.annotation.*;
*
* <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>
@@ -54,7 +55,8 @@ public class ResponseInfo extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* Required. A short description of the response.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
+ * rich text representation.
*
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -66,7 +68,8 @@ public class ResponseInfo extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* Required. A short description of the response.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -92,7 +95,8 @@ public class ResponseInfo extends SwaggerElement {
* A definition of the response structure.
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
- * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>, its root type value may also be <js>"file"</js>.
+ * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ * its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
*
* @return The value of the <property>schema</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -107,7 +111,8 @@ public class ResponseInfo extends SwaggerElement {
* A definition of the response structure.
* It can be a primitive, an array or an object.
* If this field does not exist, it means no content is returned as part of the response.
- * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>, its root type value may also be <js>"file"</js>.
+ * As an extension to the <a class="doclink" href="http://swagger.io/specification/#schemaObject">Schema Object</a>,
+ * its root type value may also be <js>"file"</js>.
* This SHOULD be accompanied by a relevant produces mime-type.
*
* @param schema The new value for the <property>schema</property> property on this bean.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
index d4f2f7e..460a051 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SchemaInfo.java
@@ -28,7 +28,8 @@ import org.apache.juneau.annotation.*;
*
* <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>
@@ -72,7 +73,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @return The value of the <property>format</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -83,7 +85,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
+ * details.
*
* @param format The new value for the <property>format</property> property on this bean.
* @return This object (for method chaining).
@@ -136,7 +139,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
* <p>
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -147,7 +151,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
* <p>
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -264,7 +269,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMaximum</property>.
*
- * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMaximum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMaximum() {
return exclusiveMaximum;
@@ -324,7 +330,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>exclusiveMinimum</property>.
*
- * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>exclusiveMinimum</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Boolean getExclusiveMinimum() {
return exclusiveMinimum;
@@ -504,7 +511,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>uniqueItems</property>.
*
- * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>uniqueItems</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Boolean getUniqueItems() {
return uniqueItems;
@@ -533,7 +541,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>maxProperties</property>.
*
- * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>maxProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Integer getMaxProperties() {
return maxProperties;
@@ -563,7 +572,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>minProperties</property>.
*
- * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>minProperties</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public Integer getMinProperties() {
return minProperties;
@@ -839,7 +849,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>additionalProperties</property>.
*
- * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>additionalProperties</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,Object> getAdditionalProperties() {
return additionalProperties;
@@ -874,7 +885,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>discriminator</property>.
*
- * @return The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>discriminator</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public String getDiscriminator() {
return discriminator;
@@ -964,7 +976,8 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
index 8856db2..f41e194 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SecurityScheme.java
@@ -22,7 +22,8 @@ import org.apache.juneau.json.*;
/**
* Allows the definition of a security scheme that can be used by the operations.
* <p>
- * Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's common flows (implicit, password, application and access code).
+ * Supported schemes are basic authentication, an API key (either as a header or as a query parameter) and OAuth2's
+ * common flows (implicit, password, application and access code).
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -52,7 +53,8 @@ import org.apache.juneau.json.*;
*
* <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>
@@ -103,7 +105,9 @@ public class SecurityScheme extends SwaggerElement {
*/
public SecurityScheme setType(String type) {
if (isStrict() && ! contains(type, VALID_TYPES))
- throw new RuntimeException("Invalid value passed in to setType(String). Value='"+type+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
+ throw new RuntimeException(
+ "Invalid value passed in to setType(String). Value='"+type+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_TYPES));
this.type = type;
return this;
}
@@ -123,7 +127,8 @@ public class SecurityScheme extends SwaggerElement {
* <p>
* A short description for security scheme.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -262,7 +267,8 @@ public class SecurityScheme extends SwaggerElement {
* The authorization URL to be used for this flow.
* This SHOULD be in the form of a URL.
*
- * @return The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>authorizationUrl</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public String getAuthorizationUrl() {
return authorizationUrl;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
index 2da4bbb..bbb8d05 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Swagger.java
@@ -23,7 +23,8 @@ import org.apache.juneau.utils.*;
*
* <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>
@@ -129,11 +130,12 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>host</property>.
* <p>
- * The host (name or ip) serving the API.
+ * The host (name or IP) serving the API.
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
- * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ * path templating</a>.
*
* @return The value of the <property>host</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -144,11 +146,12 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>host</property>.
* <p>
- * The host (name or ip) serving the API.
+ * The host (name or IP) serving the API.
* This MUST be the host only and does not include the scheme nor sub-paths.
* It MAY include a port.
* If the host is not included, the host serving the documentation is to be used (including the port).
- * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The host does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">
+ * path templating</a>.
*
* @param host The new value for the <property>host</property> property on this bean.
* @return This object (for method chaining).
@@ -174,7 +177,8 @@ public class Swagger extends SwaggerElement {
* The base path on which the API is served, which is relative to the <code>host</code>.
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
- * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The <code>basePath</code> does not support <a class="doclink"
+ * href="http://swagger.io/specification/#pathTemplating">path templating</a>.
*
* @return The value of the <property>basePath</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -188,7 +192,8 @@ public class Swagger extends SwaggerElement {
* The base path on which the API is served, which is relative to the <code>host</code>.
* If it is not included, the API is served directly under the <code>host</code>.
* The value MUST start with a leading slash (/).
- * The <code>basePath</code> does not support <a class="doclink" href="http://swagger.io/specification/#pathTemplating">path templating</a>.
+ * The <code>basePath</code> does not support <a class="doclink"
+ * href="http://swagger.io/specification/#pathTemplating">path templating</a>.
*
* @param basePath The new value for the <property>basePath</property> property on this bean.
* @return This object (for method chaining).
@@ -213,7 +218,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @return The value of the <property>schemes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -226,7 +232,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The new value for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -241,7 +248,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -255,7 +263,8 @@ public class Swagger extends SwaggerElement {
* <p>
* The transfer protocol of the API.
* Values MUST be from the list: <js>"http"</js>, <js>"https"</js>, <js>"ws"</js>, <js>"wss"</js>.
- * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger definition itself.
+ * If the <code>schemes</code> is not included, the default scheme to be used is the one used to access the Swagger
+ * definition itself.
*
* @param schemes The values to add for the <property>schemes</property> property on this bean.
* @return This object (for method chaining).
@@ -284,7 +293,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @return The value of the <property>consumes</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -297,7 +307,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The new value for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -312,7 +323,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -326,7 +338,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can consume.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param consumes The values to add for the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -365,7 +378,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @return The value of the <property>produces</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -378,7 +392,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The new value for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -393,7 +408,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -407,7 +423,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of MIME types the APIs can produce.
* This is global to all APIs but can be overridden on specific API calls.
- * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">Mime Types</a>.
+ * Value MUST be as described under <a class="doclink" href="http://swagger.io/specification/#mimeTypes">
+ * Mime Types</a>.
*
* @param produces The values to add for the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -504,7 +521,8 @@ public class Swagger extends SwaggerElement {
* <p>
* An object to hold data types produced and consumed by operations.
*
- * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>definitions</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public Map<String,SchemaInfo> getDefinitions() {
return definitions;
@@ -663,7 +681,8 @@ public class Swagger extends SwaggerElement {
* <p>
* Security scheme definitions that can be used across the specification.
*
- * @return The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>securityDefinitions</property> property on this bean, or <jk>null</jk> if it
+ * is not set.
*/
public Map<String,SecurityScheme> getSecurityDefinitions() {
return securityDefinitions;
@@ -713,7 +732,8 @@ public class Swagger extends SwaggerElement {
* Bean property getter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @return The value of the <property>security</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -726,7 +746,8 @@ public class Swagger extends SwaggerElement {
* Bean property setter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @param security The new value for the <property>security</property> property on this bean.
@@ -741,7 +762,8 @@ public class Swagger extends SwaggerElement {
* Bean property adder: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for the API as a whole.
- * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * The list of values describes alternative security schemes that can be used (that is, there is a logical OR
+ * between the security requirements).
* Individual operations can override this definition.
*
* @param security The value to add for the <property>security</property> property on this bean.
@@ -758,7 +780,8 @@ public class Swagger extends SwaggerElement {
* Synonym for {@link #addSecurity(Map)}.
*
* @param scheme The security scheme that applies to this operation
- * @param alternatives The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).
+ * @param alternatives The list of values describes alternative security schemes that can be used (that is, there
+ * is a logical OR between the security requirements).
* @return This object (for method chaining).
*/
public Swagger security(String scheme, String...alternatives) {
@@ -772,7 +795,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -787,7 +811,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -804,7 +829,8 @@ public class Swagger extends SwaggerElement {
* <p>
* A list of tags used by the specification with additional metadata.
* The order of the tags can be used to reflect on their order by the parsing tools.
- * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a> must be declared.
+ * Not all tags that are used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">
+ * Operation Object</a> must be declared.
* The tags that are not declared may be organized randomly or based on the tools' logic.
* Each tag name in the list MUST be unique.
*
@@ -843,7 +869,8 @@ public class Swagger extends SwaggerElement {
* <p>
* Additional external documentation.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is
+ * not set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
index aa71038..20d5fff 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerBuilder.java
@@ -21,7 +21,8 @@ import org.apache.juneau.*;
*
* <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>
@@ -32,6 +33,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Contact} element.
+ *
* @return The new element.
*/
public static final Contact contact() {
@@ -40,6 +42,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Contact} element with the specified {@link Contact#name(String)} attribute.
+ *
* @param name The {@link Contact#name(String)} attribute.
* @return The new element.
*/
@@ -48,7 +51,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link Contact} element with the specified {@link Contact#name(String)}, {@link Contact#url(Object)}, and {@link Contact#email(String)}, attributes.
+ * Creates an {@link Contact} element with the specified {@link Contact#name(String)}, {@link Contact#url(Object)},
+ * and {@link Contact#email(String)}, attributes.
+ *
* @param name The {@link Contact#name(String)} attribute.
* @param url The {@link Contact#url(Object)} attribute.
* The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
@@ -63,6 +68,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ExternalDocumentation} element.
+ *
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation() {
@@ -70,11 +76,13 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)} attribute.
+ * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
+ * attribute.
+ *
* @param url The {@link ExternalDocumentation#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation(Object url) {
@@ -82,11 +90,13 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)} and {@link ExternalDocumentation#description(String)} attributes.
+ * Creates an {@link ExternalDocumentation} element with the specified {@link ExternalDocumentation#url(Object)}
+ * and {@link ExternalDocumentation#description(String)} attributes.
+ *
* @param url The {@link ExternalDocumentation#url(Object)} attribute.
- * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The value can be of any of the following types: {@link URI}, {@link URL}, {@link String}.
+ * <br>Strings must be valid URIs.
+ * <br>URIs defined by {@link UriResolver} can be used for values.
* @param description The {@link ExternalDocumentation#description(String)} attribute.
* @return The new element.
*/
@@ -96,6 +106,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link HeaderInfo} element.
+ *
* @return The new element.
*/
public static final HeaderInfo headerInfo() {
@@ -104,6 +115,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -113,6 +125,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link HeaderInfo} element with the specified {@link HeaderInfo#type(String)} attribute.
+ *
* @param type The {@link HeaderInfo#type(String)} attribute.
* @return The new element.
*/
@@ -122,6 +135,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Info} element.
+ *
* @return The new element.
*/
public static final Info info() {
@@ -129,7 +143,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link Info} element with the specified {@link Info#title(String)} and {@link Info#version(String)} attributes.
+ * Creates an {@link Info} element with the specified {@link Info#title(String)} and {@link Info#version(String)}
+ * attributes.
+ *
* @param title The {@link Info#title(String)} attribute.
* @param version The {@link Info#version(String)} attribute.
* @return The new element.
@@ -140,6 +156,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Items} element.
+ *
* @return The new element.
*/
public static final Items items() {
@@ -148,6 +165,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -157,6 +175,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Items} element with the specified {@link Items#type(String)} attribute.
+ *
* @param type The {@link Items#type(String)} attribute.
* @return The new element.
*/
@@ -166,6 +185,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link License} element.
+ *
* @return The new element.
*/
public static final License license() {
@@ -174,6 +194,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link License} element with the specified {@link License#name(String)} attribute.
+ *
* @param name The {@link License#name(String)} attribute.
* @return The new element.
*/
@@ -183,6 +204,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Operation} element.
+ *
* @return The new element.
*/
public static final Operation operation() {
@@ -191,6 +213,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ParameterInfo} element.
+ *
* @return The new element.
*/
public static final ParameterInfo parameterInfo() {
@@ -198,7 +221,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and {@link ParameterInfo#name(String)} attributes.
+ * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
+ * {@link ParameterInfo#name(String)} attributes.
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -208,7 +233,9 @@ public class SwaggerBuilder {
}
/**
- * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and {@link ParameterInfo#name(String)} attributes.
+ * Creates an {@link ParameterInfo} element with the specified {@link ParameterInfo#in(String)} and
+ * {@link ParameterInfo#name(String)} attributes.
+ *
* @param in The {@link ParameterInfo#in(String)} attribute.
* @param name The {@link ParameterInfo#name(String)} attribute.
* @return The new element.
@@ -219,6 +246,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link ResponseInfo} element.
+ *
* @return The new element.
*/
public static final ResponseInfo responseInfo() {
@@ -228,6 +256,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link ResponseInfo} element with the specified {@link ResponseInfo#description(String)} attribute.
* @param description The {@link ResponseInfo#description(String)} attribute.
+ *
* @return The new element.
*/
public static final ResponseInfo responseInfo(String description) {
@@ -236,6 +265,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SchemaInfo} element.
+ *
* @return The new element.
*/
public static final SchemaInfo schemaInfo() {
@@ -244,6 +274,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link SecurityScheme} element.
+ *
* @return The new element.
*/
public static final SecurityScheme securityScheme() {
@@ -252,6 +283,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -261,6 +293,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link SecurityScheme} element with the specified {@link SecurityScheme#type(String)} attribute.
+ *
* @param type The {@link SecurityScheme#type(String)} attribute.
* @return The new element.
*/
@@ -270,6 +303,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Swagger} element.
+ *
* @return The new element.
*/
public static final Swagger swagger() {
@@ -278,6 +312,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Swagger} element with the specified {@link Swagger#info(Info)} attribute.
+ *
* @param info The {@link Swagger#info(Info)} attribute.
* @return The new element.
*/
@@ -287,6 +322,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Tag} element.
+ *
* @return The new element.
*/
public static final Tag tag() {
@@ -295,6 +331,7 @@ public class SwaggerBuilder {
/**
* Creates an {@link Tag} element with the specified {@link Tag#name(String)} attribute.
+ *
* @param name The {@link Tag#name(String)} attribute.
* @return The new element.
*/
@@ -304,6 +341,7 @@ public class SwaggerBuilder {
/**
* Creates an empty {@link Xml} element.
+ *
* @return The new element.
*/
public static final Xml xml() {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
index d6ae5c9..a768d59 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/SwaggerElement.java
@@ -17,7 +17,8 @@ package org.apache.juneau.dto.swagger;
*
* <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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
index c6e13cd..3c2d504 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Tag.java
@@ -15,7 +15,8 @@ package org.apache.juneau.dto.swagger;
import org.apache.juneau.annotation.*;
/**
- * Allows adding meta data to a single tag that is used by the <a class="doclink" href="http://swagger.io/specification/#operationObject">Operation Object</a>.
+ * Allows adding meta data to a single tag that is used by the <a class="doclink"
+ * href="http://swagger.io/specification/#operationObject">Operation Object</a>.
* <p>
* It is not mandatory to have a Tag Object per tag used there.
*
@@ -29,7 +30,8 @@ import org.apache.juneau.annotation.*;
*
* <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>
@@ -82,9 +84,11 @@ public class Tag extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* A short description for the tag.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
- * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getDescription() {
return description;
@@ -94,7 +98,8 @@ public class Tag extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* A short description for the tag.
- * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for rich text representation.
+ * <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
+ * for rich text representation.
*
* @param description The new value for the <property>description</property> property on this bean.
* @return This object (for method chaining).
@@ -119,7 +124,8 @@ public class Tag extends SwaggerElement {
* <p>
* Additional external documentation for this tag.
*
- * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>externalDocs</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public ExternalDocumentation getExternalDocs() {
return externalDocs;