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:31 UTC
[16/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/jsonschema/package.html
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
index 1551244..17f1d36 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/jsonschema/package.html
@@ -71,11 +71,15 @@
<h2 class='topic' onclick='toggle(this)'>1 - Overview</h2>
<div class='topic'>
<p>
- Juneau supports serializing and parsing of JSON-Schema documents through the use of beans defined in the <code>org.apache.juneau.dto.jsonschema</code> package.<br>
- These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and {@link org.apache.juneau.json.JsonParser} classes to produce and consume JSON-Schema documents.
+ Juneau supports serializing and parsing of JSON-Schema documents through the use of beans defined in the
+ <code>org.apache.juneau.dto.jsonschema</code> package.
+ <br>
+ These beans are used with the existing {@link org.apache.juneau.json.JsonSerializer} and
+ {@link org.apache.juneau.json.JsonParser} classes to produce and consume JSON-Schema documents.
</p>
<p>
- <b>NOTE:</b> JSON-Schema is currently in draft form. This API may change as the JSON-Schema specification changes.
+ <b>NOTE:</b> JSON-Schema is currently in draft form.
+ This API may change as the JSON-Schema specification changes.
</p>
<!-- ======================================================================================================== -->
@@ -101,10 +105,12 @@
<js>"minimum"</js>: 0
},
<js>"positiveIntegerDefault0"</js>: {
- <js>"allOf"</js>: [ { <js>"$ref"</js>: <js>"#/definitions/positiveInteger"</js> }, { <js>"default"</js>: 0 } ]
+ <js>"allOf"</js>: [ { <js>"$ref"</js>: <js>"#/definitions/positiveInteger"</js> },
+ { <js>"default"</js>: 0 } ]
},
<js>"simpleTypes"</js>: {
- <js>"enum"</js>: [ <js>"array"</js>, <js>"boolean"</js>, <js>"integer"</js>, <js>"null"</js>, <js>"number"</js>, <js>"object"</js>, <js>"string"</js> ]
+ <js>"enum"</js>: [ <js>"array"</js>, <js>"boolean"</js>, <js>"integer"</js>, <js>"null"</js>,
+ <js>"number"</js>, <js>"object"</js>, <js>"string"</js> ]
},
<js>"stringArray"</js>: {
<js>"type"</js>: <js>"array"</js>,
@@ -242,8 +248,10 @@
</p>
<ul class='spaced-list'>
<li>{@link org.apache.juneau.dto.jsonschema.Schema} - Top level schema object.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for representing properties.
- <li>{@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of <code>SchemaProperty</code> for representing properties of simple array types.
+ <li>{@link org.apache.juneau.dto.jsonschema.SchemaProperty} - A subclass of <code>Schema</code> for
+ representing properties.
+ <li>{@link org.apache.juneau.dto.jsonschema.SchemaPropertySimpleArray} - A convenience subclass of
+ <code>SchemaProperty</code> for representing properties of simple array types.
<li>{@link org.apache.juneau.dto.jsonschema.SchemaRef} - Represents a URI reference to another schema.
<li>{@link org.apache.juneau.dto.jsonschema.SchemaArray} - An array of <code>Schema</code> objects.
<li>{@link org.apache.juneau.dto.jsonschema.JsonType} - An enum of possible JSON data types.
@@ -392,7 +400,8 @@
<h4 class='topic' onclick='toggle(this)'>1.2.1 - Serializing to other data types</h4>
<div class='topic'>
<p>
- Since the JSON-Schema DTOs are simple beans, they can be used to serialize to a variety of other language types as well as JSON.
+ Since the JSON-Schema DTOs are simple beans, they can be used to serialize to a variety of other
+ language types as well as JSON.
This also allows JSON-Schema documents to be easily served up using the Juneau REST API.
</p>
<p>
@@ -462,14 +471,15 @@
}
</p>
<p>
- When you point your browser to this resource, the default content type is HTML (since that's what the browser asks for
- by default).
+ When you point your browser to this resource, the default content type is HTML (since that's what the
+ browser asks for by default).
</p>
<h6 class='figure'>HTML</h6>
<img class='bordered' src="doc-files/Example_Html.png">
<p>
- The REST API allows you to specify the <code>Accept</code> header as a GET parameter, and the <code>plainText=true</code>
- parameter forces the returned <code>Content-Type</code> to be <code>text/plain</code>.
+ The REST API allows you to specify the <code>Accept</code> header as a GET parameter, and the
+ <code>plainText=true</code> parameter forces the returned <code>Content-Type</code> to be
+ <code>text/plain</code>.
We'll use this to view the JSON-Schema document in other languages.
</p>
@@ -489,7 +499,8 @@
<img class='bordered' src="doc-files/Example_Turtle.png">
<p>
- The full list of options for this resource can be accessed by the <code>options</code> link on the HTML page.
+ The full list of options for this resource can be accessed by the <code>options</code> link on the HTML
+ page.
</p>
<h6 class='figure'>Resource Options</h6>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
index 54102a8..85f8c04 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Contact.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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
index 2679755..eb84844 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/ExternalDocumentation.java
@@ -33,7 +33,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>
@@ -52,7 +53,8 @@ public class ExternalDocumentation extends SwaggerElement {
* <p>
* A short description of the target documentation. GFM syntax 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;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
index 434598b..5ae1939 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/HeaderInfo.java
@@ -32,7 +32,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>
@@ -76,7 +77,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* A short description of the header.
*
- * @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;
@@ -109,7 +111,8 @@ public class HeaderInfo extends SwaggerElement {
* Bean property getter: <property>type</property>.
* <p>
* Required. The type of the object.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <
+ * js>"array"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -121,14 +124,17 @@ public class HeaderInfo extends SwaggerElement {
* Bean property setter: <property>type</property>.
* <p>
* Required. The type of the object.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public HeaderInfo 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;
}
@@ -146,7 +152,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. 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.
*/
@@ -157,7 +164,8 @@ public class HeaderInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. 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).
@@ -254,7 +262,9 @@ public class HeaderInfo extends SwaggerElement {
*/
public HeaderInfo setCollectionFormat(String collectionFormat) {
if (isStrict() && ! contains(collectionFormat, VALID_COLLECTION_FORMATS))
- throw new RuntimeException("Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
+ throw new RuntimeException(
+ "Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
this.collectionFormat = collectionFormat;
return this;
}
@@ -274,7 +284,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * 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 the header.
*
* @return The value of the <property>_default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -288,7 +299,8 @@ public class HeaderInfo extends SwaggerElement {
* <p>
* Declares the value of the header that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * 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 the header.
*
* @param _default The new value for the <property>_default</property> property on this bean.
@@ -312,7 +324,8 @@ public class HeaderInfo 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.
*/
@@ -323,7 +336,8 @@ public class HeaderInfo 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).
@@ -346,9 +360,11 @@ public class HeaderInfo 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;
@@ -357,7 +373,8 @@ public class HeaderInfo 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).
@@ -380,7 +397,8 @@ public class HeaderInfo 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.
*/
@@ -391,7 +409,8 @@ public class HeaderInfo 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).
@@ -414,9 +433,11 @@ public class HeaderInfo 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;
@@ -425,7 +446,8 @@ public class HeaderInfo 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).
@@ -448,7 +470,8 @@ public class HeaderInfo 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.
*/
@@ -459,7 +482,8 @@ public class HeaderInfo 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).
@@ -482,7 +506,8 @@ public class HeaderInfo 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.
*/
@@ -493,7 +518,8 @@ public class HeaderInfo 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).
@@ -515,7 +541,8 @@ public class HeaderInfo 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.
*/
@@ -526,7 +553,8 @@ public class HeaderInfo 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).
@@ -549,7 +577,8 @@ public class HeaderInfo 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.
*/
@@ -560,7 +589,8 @@ public class HeaderInfo 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).
@@ -583,7 +613,8 @@ public class HeaderInfo 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.
*/
@@ -594,7 +625,8 @@ public class HeaderInfo 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).
@@ -617,7 +649,8 @@ public class HeaderInfo 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.
*/
@@ -628,7 +661,8 @@ public class HeaderInfo 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).
@@ -651,7 +685,8 @@ public class HeaderInfo 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.
*/
@@ -662,7 +697,8 @@ public class HeaderInfo 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).
@@ -675,7 +711,8 @@ public class HeaderInfo 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.
@@ -709,7 +746,8 @@ public class HeaderInfo 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.
*/
@@ -720,7 +758,8 @@ public class HeaderInfo 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/Info.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
index 20676d8..98476f5 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Info.java
@@ -15,7 +15,8 @@ package org.apache.juneau.dto.swagger;
import org.apache.juneau.annotation.*;
/**
- * The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented in the Swagger-UI for convenience.
+ * The object provides metadata about the API. The metadata can be used by the clients if needed, and can be presented
+ * in the Swagger-UI for convenience.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -38,7 +39,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>
@@ -95,7 +97,8 @@ public class Info extends SwaggerElement {
* <p>
* A short description of the application. GFM syntax 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;
@@ -129,7 +132,8 @@ public class Info extends SwaggerElement {
* <p>
* The Terms of Service for the API.
*
- * @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>termsOfService</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getTermsOfService() {
return termsOfService;
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
index ca63e71..538c3c7 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Items.java
@@ -32,7 +32,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>
@@ -74,7 +75,8 @@ public class Items extends SwaggerElement {
* Bean property getter: <property>type</property>.
* <p>
* Required. The internal type of the array.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
*/
@@ -86,14 +88,17 @@ public class Items extends SwaggerElement {
* Bean property setter: <property>type</property>.
* <p>
* Required. The internal type of the array.
- * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or <js>"array"</js>.
+ * The value MUST be one of <js>"string"</js>, <js>"number"</js>, <js>"integer"</js>, <js>"boolean"</js>, or
+ * <js>"array"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
* @return This object (for method chaining).
*/
public Items 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;
}
@@ -111,7 +116,8 @@ public class Items extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. 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.
*/
@@ -122,7 +128,8 @@ public class Items extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
* <p>
- * The extending format for the previously mentioned <code>type</code>. See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further details.
+ * The extending format for the previously mentioned <code>type</code>. 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).
@@ -193,7 +200,8 @@ public class Items extends SwaggerElement {
* <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;
@@ -219,7 +227,9 @@ public class Items extends SwaggerElement {
*/
public Items setCollectionFormat(String collectionFormat) {
if (isStrict() && ! contains(collectionFormat, VALID_COLLECTION_FORMATS))
- throw new RuntimeException("Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values=" + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
+ throw new RuntimeException(
+ "Invalid value passed in to setCollectionFormat(String). Value='"+collectionFormat+"', valid values="
+ + JsonSerializer.DEFAULT_LAX.toString(VALID_COLLECTION_FORMATS));
this.collectionFormat = collectionFormat;
return this;
}
@@ -239,7 +249,8 @@ public class Items extends SwaggerElement {
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * 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 the data type.
*
* @return The value of the <property>default</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -253,7 +264,8 @@ public class Items extends SwaggerElement {
* <p>
* Declares the value of the item that the server will use if none is provided.
* (Note: <js>"default"</js> has no meaning for required items.)
- * 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 the data type.
*
* @param _default The new value for the <property>default</property> property on this bean.
@@ -277,7 +289,8 @@ public class Items 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.
*/
@@ -288,7 +301,8 @@ public class Items 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).
@@ -311,9 +325,11 @@ public class Items 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;
@@ -322,7 +338,8 @@ public class Items 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).
@@ -345,7 +362,8 @@ public class Items 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.
*/
@@ -356,7 +374,8 @@ public class Items 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).
@@ -379,9 +398,11 @@ public class Items 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;
@@ -390,7 +411,8 @@ public class Items 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).
@@ -413,7 +435,8 @@ public class Items 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.
*/
@@ -424,7 +447,8 @@ public class Items 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).
@@ -447,7 +471,8 @@ public class Items 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.
*/
@@ -458,7 +483,8 @@ public class Items 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).
@@ -481,7 +507,8 @@ public class Items 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.
*/
@@ -492,7 +519,8 @@ public class Items 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).
@@ -515,7 +543,8 @@ public class Items 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.
*/
@@ -526,7 +555,8 @@ public class Items 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).
@@ -549,7 +579,8 @@ public class Items 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.
*/
@@ -560,7 +591,8 @@ public class Items 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).
@@ -583,9 +615,11 @@ public class Items 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;
@@ -594,7 +628,8 @@ public class Items 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).
@@ -617,7 +652,8 @@ public class Items 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.
*/
@@ -628,7 +664,8 @@ public class Items 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).
@@ -641,7 +678,8 @@ public class Items 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.
@@ -676,7 +714,8 @@ public class Items 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.
*/
@@ -687,7 +726,8 @@ public class Items 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/License.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
index 13cef34..9fcc469 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/License.java
@@ -33,7 +33,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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/5c4762ee/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
index c374772..f9d65b6 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Operation.java
@@ -80,7 +80,8 @@ import org.apache.juneau.http.*;
*
* <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>
@@ -222,9 +223,11 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>description</property>.
* <p>
* A verbose explanation of the operation behavior.
- * <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;
@@ -234,7 +237,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>description</property>.
* <p>
* A verbose explanation of the operation behavior.
- * <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).
@@ -259,7 +263,8 @@ public class Operation extends SwaggerElement {
* <p>
* Additional external documentation for this operation.
*
- * @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;
@@ -292,9 +297,11 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>operationId</property>.
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
- * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
+ * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ * follow common programming naming conventions.
*
- * @return The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not set.
+ * @return The value of the <property>operationId</property> property on this bean, or <jk>null</jk> if it is not
+ * set.
*/
public String getOperationId() {
return operationId;
@@ -304,7 +311,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>operationId</property>.
* <p>
* Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
- * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.
+ * Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to
+ * follow common programming naming conventions.
*
* @param operationId The new value for the <property>operationId</property> property on this bean.
* @return This object (for method chaining).
@@ -330,7 +338,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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.
*/
@@ -344,7 +353,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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).
@@ -360,7 +370,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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 values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -375,7 +386,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can consume.
* This overrides the <code>consumes</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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 values to add to the <property>consumes</property> property on this bean.
* @return This object (for method chaining).
@@ -415,7 +427,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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.
*/
@@ -429,7 +442,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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).
@@ -445,7 +459,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produce.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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).
@@ -465,7 +480,8 @@ public class Operation extends SwaggerElement {
* A list of MIME types the operation can produces.
* This overrides the <code>produces</code> definition at the Swagger Object.
* An empty value MAY be used to clear the global definition.
- * 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 values to add to the <property>produces</property> property on this bean.
* @return This object (for method chaining).
@@ -503,10 +519,15 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's
+ * parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -519,10 +540,15 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @param parameters The new value for the <property>parameters</property> property on this bean.
@@ -537,10 +563,15 @@ public class Operation extends SwaggerElement {
* Bean property adder: <property>parameters</property>.
* <p>
* A list of parameters that are applicable for this operation.
- * If a parameter is already defined at the <a class="doclink" href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it, but can never remove it.
+ * If a parameter is already defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#pathItemParameters">Path Item</a>, the new definition will override it,
+ * but can never remove it.
* The list MUST NOT include duplicated parameters.
* A unique parameter is defined by a combination of a <code>name</code> and <code>location</code>.
- * The list can use the <a class="doclink" href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are defined at the <a class="doclink" href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
+ * The list can use the <a class="doclink"
+ * href="http://swagger.io/specification/#referenceObject">Reference Object</a> to link to parameters that are
+ * defined at the <a class="doclink"
+ * href="http://swagger.io/specification/#swaggerParameters">Swagger Object's parameters</a>.
* There can be one <js>"body"</js> parameter at most.
*
* @param parameters The new value to add to the <property>parameters</property> property on this bean.
@@ -745,7 +776,8 @@ public class Operation extends SwaggerElement {
* Bean property getter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * 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).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -759,7 +791,8 @@ public class Operation extends SwaggerElement {
* Bean property setter: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * 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).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -775,7 +808,8 @@ public class Operation extends SwaggerElement {
* Bean property adder: <property>security</property>.
* <p>
* A declaration of which security schemes are applied for this operation.
- * 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).
* This definition overrides any declared top-level security.
* To remove a top-level <code>security</code> declaration, an empty array can be used.
*
@@ -793,7 +827,8 @@ public class Operation 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 Operation security(String scheme, String...alternatives) {