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/28 01:49:42 UTC
[3/9] incubator-juneau git commit: Clean up javadocs.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 7bc56ac..52ae75e 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
@@ -21,8 +21,10 @@ import org.apache.juneau.json.*;
/**
* Describes a single operation parameter.
+ *
* <p>
* A unique parameter is defined by a combination of a name and location.
+ *
* <p>
* There are five possible parameter types.
* <ul>
@@ -116,8 +118,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* Required. The name of the parameter.
+ *
+ * <p>
* 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"
@@ -134,8 +139,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* Required. The name of the parameter.
+ *
+ * <p>
* 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"
@@ -165,8 +173,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
+ *
* <p>
* Required. The location of the parameter.
+ *
+ * <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
*
* @return The value of the <property>in</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -177,8 +188,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
+ *
* <p>
* Required. The location of the parameter.
+ *
+ * <p>
* Possible values are <js>"query"</js>, <js>"header"</js>, <js>"path"</js>, <js>"formData"</js> or <js>"body"</js>.
*
* @param in The new value for the <property>in</property> property on this bean.
@@ -207,14 +221,17 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
+ *
* <p>
* A brief description of the parameter.
+ *
+ * <p>
* 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.
*
- * @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;
@@ -222,8 +239,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* A brief description of the parameter.
+ *
+ * <p>
* 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.
@@ -248,8 +268,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>required</property>.
+ *
* <p>
* Determines whether this parameter is mandatory.
+ *
+ * <p>
* 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>.
@@ -262,8 +285,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>required</property>.
+ *
* <p>
* Determines whether this parameter is mandatory.
+ *
+ * <p>
* 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>.
@@ -288,6 +314,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
*
@@ -299,6 +326,7 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
+ *
* <p>
* Required. The schema defining the type used for the body parameter.
*
@@ -322,8 +350,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
+ *
* <p>
* Required. The type of the parameter.
+ *
+ * <p>
* 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>.
@@ -339,8 +370,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
+ *
* <p>
* Required. The type of the parameter.
+ *
+ * <p>
* 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>.
@@ -372,8 +406,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>format</property>.
+ *
* <p>
* The extending format for the previously mentioned type.
+ *
+ * <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
*
@@ -385,8 +422,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>format</property>.
+ *
* <p>
* The extending format for the previously mentioned type.
+ *
+ * <p>
* See <a class="doclink" href="http://swagger.io/specification/#dataTypeFormat">Data Type Formats</a> for further
* details.
*
@@ -410,8 +450,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>allowEmptyValue</property>.
+ *
* <p>
* Sets the ability to pass empty-valued parameters.
+ *
+ * <p>
* 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>.
@@ -425,8 +468,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>allowEmptyValue</property>.
+ *
* <p>
* Sets the ability to pass empty-valued parameters.
+ *
+ * <p>
* 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>.
@@ -451,8 +497,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>items</property>.
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
+ *
+ * <p>
* Describes the type of items in the array.
*
* @return The value of the <property>items</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -463,8 +512,11 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>items</property>.
+ *
* <p>
* Required if <code>type</code> is <js>"array"</js>.
+ *
+ * <p>
* Describes the type of items in the array.
*
* @param items The new value for the <property>items</property> property on this bean.
@@ -487,8 +539,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property getter: <property>collectionFormat</property>.
+ *
* <p>
* Determines the format of the array if type array is used.
+ *
* <p>
* Possible values are:
* <ul>
@@ -500,11 +554,13 @@ public class ParameterInfo extends SwaggerElement {
* 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;
@@ -512,8 +568,10 @@ public class ParameterInfo extends SwaggerElement {
/**
* Bean property setter: <property>collectionFormat</property>.
+ *
* <p>
* Determines the format of the array if type array is used.
+ *
* <p>
* Possible values are:
* <ul>
@@ -525,6 +583,7 @@ public class ParameterInfo extends SwaggerElement {
* 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>.
*
@@ -550,6 +609,7 @@ 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.
@@ -566,6 +626,7 @@ 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.
@@ -594,6 +655,7 @@ 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>.
@@ -606,6 +668,7 @@ 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>.
@@ -630,6 +693,7 @@ 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>.
@@ -643,6 +707,7 @@ 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>.
@@ -667,6 +732,7 @@ 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>.
@@ -679,6 +745,7 @@ 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>.
@@ -703,6 +770,7 @@ 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>.
@@ -716,6 +784,7 @@ 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>.
@@ -740,6 +809,7 @@ 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>.
@@ -752,6 +822,7 @@ 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>.
@@ -776,6 +847,7 @@ 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>.
@@ -788,6 +860,7 @@ 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>.
@@ -812,6 +885,7 @@ 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>.
@@ -824,6 +898,7 @@ 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>.
@@ -848,6 +923,7 @@ 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>.
@@ -860,6 +936,7 @@ 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>.
@@ -884,6 +961,7 @@ 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>.
@@ -896,6 +974,7 @@ 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>.
@@ -920,6 +999,7 @@ 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>.
@@ -933,6 +1013,7 @@ 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>.
@@ -957,6 +1038,7 @@ 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>.
@@ -969,6 +1051,7 @@ 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>.
@@ -983,12 +1066,14 @@ 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>.
*
- * @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.
+ * @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.
* @return This object (for method chaining).
*/
@SuppressWarnings("unchecked")
@@ -1010,8 +1095,9 @@ public class ParameterInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
*
- * @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.
+ * @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.
* @return This object (for method chaining).
*/
public ParameterInfo _enum(Object..._enum) {
@@ -1020,6 +1106,7 @@ 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>.
@@ -1032,6 +1119,7 @@ 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>.
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 ebfefda..6fda9a7 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
@@ -58,8 +58,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
+ *
* <p>
* Required. A short description of the response.
+ *
+ * <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used for
* rich text representation.
*
@@ -71,8 +74,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* Required. A short description of the response.
+ *
+ * <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
*
@@ -96,8 +102,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>schema</property>.
+ *
* <p>
* A definition of the response structure.
+ *
+ * <p>
* 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>,
@@ -112,8 +121,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>schema</property>.
+ *
* <p>
* A definition of the response structure.
+ *
+ * <p>
* 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>,
@@ -140,6 +152,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -151,6 +164,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -164,6 +178,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>headers</property>.
+ *
* <p>
* A list of headers that are sent with the response.
*
@@ -191,8 +206,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property getter: <property>examples</property>.
+ *
* <p>
* An example of the response message.
+ *
+ * <p>
* Keys must be MIME-type strings.
*
* @return The value of the <property>examples</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -203,8 +221,11 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property setter: <property>examples</property>.
+ *
* <p>
* An example of the response message.
+ *
+ * <p>
* Keys must be MIME-type strings.
*
* @param examples The new value for the <property>examples</property> property on this bean.
@@ -217,6 +238,7 @@ public class ResponseInfo extends SwaggerElement {
/**
* Bean property adder: <property>examples</property>.
+ *
* <p>
* An example of the response message.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 1a4c53b..f52fd6b 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
@@ -18,10 +18,12 @@ import org.apache.juneau.annotation.*;
/**
* The Schema Object allows the definition of input and output data types.
+ *
* <p>
* These types can be objects, but also primitives and arrays.
* This object is based on the JSON Schema Specification Draft 4 and uses a predefined subset of it.
* On top of this subset, there are extensions provided by this specification to allow for more complete documentation.
+ *
* <p>
* Further information about the properties can be found in JSON Schema Core and JSON Schema Validation.
* Unless stated otherwise, the property definitions follow the JSON Schema specification as referenced here.
@@ -77,6 +79,7 @@ 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.
@@ -89,6 +92,7 @@ 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.
@@ -143,6 +147,7 @@ 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.
@@ -155,6 +160,7 @@ 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.
@@ -179,6 +185,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property getter: <property>default</property>.
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
*
@@ -190,6 +197,7 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property setter: <property>default</property>.
+ *
* <p>
* Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object.
*
@@ -274,8 +282,9 @@ 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;
@@ -335,8 +344,9 @@ 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;
@@ -680,8 +690,9 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addEnum(Object...)}.
*
- * @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.
+ * @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.
* @return This object (for method chaining).
*/
public SchemaInfo _enum(Object..._enum) {
@@ -771,8 +782,9 @@ public class SchemaInfo extends SwaggerElement {
/**
* Bean property adder: <property>enum</property>.
*
- * @param allOf The new values to add to the <property>allOf</property> property on this bean.
- * These can either be individual objects or {@link Collection Collections} of objects.
+ * @param allOf
+ * The new values to add to the <property>allOf</property> property on this bean.
+ * These can either be individual objects or {@link Collection Collections} of objects.
* @return This object (for method chaining).
*/
public SchemaInfo addAllOf(Object...allOf) {
@@ -793,8 +805,9 @@ public class SchemaInfo extends SwaggerElement {
/**
* Synonym for {@link #addAllOf(Object...)}.
*
- * @param allOf The new values to add to the <property>allOf</property> property on this bean.
- * These can either be individual objects or {@link Collection Collections} of objects.
+ * @param allOf
+ * The new values to add to the <property>allOf</property> property on this bean.
+ * These can either be individual objects or {@link Collection Collections} of objects.
* @return This object (for method chaining).
*/
public SchemaInfo allOf(Object...allOf) {
@@ -854,8 +867,9 @@ 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;
@@ -890,8 +904,9 @@ 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;
@@ -981,8 +996,9 @@ 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/19c566dd/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 325990b..62f0af5 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
@@ -21,6 +21,7 @@ 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).
@@ -89,8 +90,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>type</property>.
+ *
* <p>
* Required. The type of the security scheme.
+ *
+ * <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
*
* @return The value of the <property>type</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -101,8 +105,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>type</property>.
+ *
* <p>
* Required. The type of the security scheme.
+ *
+ * <p>
* Valid values are <js>"basic"</js>, <js>"apiKey"</js> or <js>"oauth2"</js>.
*
* @param type The new value for the <property>type</property> property on this bean.
@@ -129,11 +136,12 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
+ *
* <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;
@@ -141,6 +149,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* A short description for security scheme.
*
@@ -164,6 +173,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* The name of the header or query parameter to be used.
*
@@ -175,6 +185,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* The name of the header or query parameter to be used.
*
@@ -198,6 +209,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>in</property>.
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
*
@@ -209,6 +221,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>in</property>.
+ *
* <p>
* The location of the API key. Valid values are <js>"query"</js> or <js>"header"</js>.
*
@@ -232,8 +245,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>flow</property>.
+ *
* <p>
* The flow used by the OAuth2 security scheme.
+ *
+ * <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
*
* @return The value of the <property>flow</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -244,8 +260,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>flow</property>.
+ *
* <p>
* The flow used by the OAuth2 security scheme.
+ *
+ * <p>
* Valid values are <js>"implicit"</js>, <js>"password"</js>, <js>"application"</js> or <js>"accessCode"</js>.
*
* @param flow The new value for the <property>flow</property> property on this bean.
@@ -268,12 +287,16 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>authorizationUrl</property>.
+ *
* <p>
* The authorization URL to be used for this flow.
+ *
+ * <p>
* 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;
@@ -281,8 +304,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>authorizationUrl</property>.
+ *
* <p>
* The authorization URL to be used for this flow.
+ *
+ * <p>
* This SHOULD be in the form of a URL.
*
* @param authorizationUrl The new value for the <property>authorizationUrl</property> property on this bean.
@@ -305,8 +331,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>tokenUrl</property>.
+ *
* <p>
* The token URL to be used for this flow.
+ *
+ * <p>
* This SHOULD be in the form of a URL.
*
* @return The value of the <property>tokenUrl</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -317,8 +346,11 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>tokenUrl</property>.
+ *
* <p>
* The token URL to be used for this flow.
+ *
+ * <p>
* This SHOULD be in the form of a URL.
*
* @param tokenUrl The new value for the <property>tokenUrl</property> property on this bean.
@@ -341,6 +373,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property getter: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
@@ -352,6 +385,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property setter: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
@@ -365,6 +399,7 @@ public class SecurityScheme extends SwaggerElement {
/**
* Bean property adder: <property>scopes</property>.
+ *
* <p>
* The available scopes for the OAuth2 security scheme.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 5046967..8500444 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
@@ -60,8 +60,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>swagger</property>.
+ *
* <p>
* Required. Specifies the Swagger Specification version being used.
+ *
+ * <p>
* It can be used by the Swagger UI and other clients to interpret the API listing.
* The value MUST be <js>"2.0"</js>.
*
@@ -73,8 +76,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>swagger</property>.
+ *
* <p>
* Required. Specifies the Swagger Specification version being used.
+ *
+ * <p>
* It can be used by the Swagger UI and other clients to interpret the API listing.
* The value MUST be <js>"2.0"</js>.
*
@@ -98,8 +104,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>info</property>.
+ *
* <p>
* Required. Provides metadata about the API.
+ *
+ * <p>
* The metadata can be used by the clients if needed.
*
* @return The value of the <property>info</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -110,8 +119,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>info</property>.
+ *
* <p>
* Required. Provides metadata about the API.
+ *
+ * <p>
* The metadata can be used by the clients if needed.
*
* @param info The new value for the <property>info</property> property on this bean.
@@ -134,8 +146,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>host</property>.
+ *
* <p>
* The host (name or IP) serving the API.
+ *
+ * <p>
* 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).
@@ -150,8 +165,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>host</property>.
+ *
* <p>
* The host (name or IP) serving the API.
+ *
+ * <p>
* 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).
@@ -178,8 +196,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>basePath</property>.
+ *
* <p>
* The base path on which the API is served, which is relative to the <code>host</code>.
+ *
+ * <p>
* 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"
@@ -193,8 +214,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>basePath</property>.
+ *
* <p>
* The base path on which the API is served, which is relative to the <code>host</code>.
+ *
+ * <p>
* 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"
@@ -220,8 +244,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>schemes</property>.
+ *
* <p>
* The transfer protocol of the API.
+ *
+ * <p>
* 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.
@@ -234,8 +261,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>schemes</property>.
+ *
* <p>
* The transfer protocol of the API.
+ *
+ * <p>
* 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.
@@ -250,8 +280,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
+ *
* <p>
* The transfer protocol of the API.
+ *
+ * <p>
* 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.
@@ -265,8 +298,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>schemes</property>.
+ *
* <p>
* The transfer protocol of the API.
+ *
+ * <p>
* 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.
@@ -295,8 +331,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>consumes</property>.
+ *
* <p>
* A list of MIME types the APIs can consume.
+ *
+ * <p>
* 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>.
@@ -309,8 +348,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>consumes</property>.
+ *
* <p>
* A list of MIME types the APIs can consume.
+ *
+ * <p>
* 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>.
@@ -325,8 +367,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
+ *
* <p>
* A list of MIME types the APIs can consume.
+ *
+ * <p>
* 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>.
@@ -340,8 +385,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>consumes</property>.
+ *
* <p>
* A list of MIME types the APIs can consume.
+ *
+ * <p>
* 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>.
@@ -380,8 +428,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>produces</property>.
+ *
* <p>
* A list of MIME types the APIs can produce.
+ *
+ * <p>
* 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>.
@@ -394,8 +445,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>produces</property>.
+ *
* <p>
* A list of MIME types the APIs can produce.
+ *
+ * <p>
* 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>.
@@ -410,8 +464,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
+ *
* <p>
* A list of MIME types the APIs can produce.
+ *
+ * <p>
* 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>.
@@ -425,8 +482,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>produces</property>.
+ *
* <p>
* A list of MIME types the APIs can produce.
+ *
+ * <p>
* 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>.
@@ -465,6 +525,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -476,6 +537,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -489,6 +551,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>paths</property>.
+ *
* <p>
* Required. The available paths and operations for the API.
*
@@ -523,11 +586,12 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>definitions</property>.
+ *
* <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;
@@ -535,6 +599,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>definitions</property>.
+ *
* <p>
* An object to hold data types produced and consumed by operations.
*
@@ -548,6 +613,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>definitions</property>.
+ *
* <p>
* An object to hold data types produced and consumed by operations.
*
@@ -575,8 +641,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>parameters</property>.
+ *
* <p>
* An object to hold parameters that can be used across operations.
+ *
+ * <p>
* This property does not define global parameters for all operations.
*
* @return The value of the <property>parameters</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -587,8 +656,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>parameters</property>.
+ *
* <p>
* An object to hold parameters that can be used across operations.
+ *
+ * <p>
* This property does not define global parameters for all operations.
*
* @param parameters The new value for the <property>parameters</property> property on this bean.
@@ -601,8 +673,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>parameters</property>.
+ *
* <p>
* An object to hold parameters that can be used across operations.
+ *
+ * <p>
* This property does not define global parameters for all operations.
*
* @param name The parameter name.
@@ -629,8 +704,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>responses</property>.
+ *
* <p>
* An object to hold responses that can be used across operations.
+ *
+ * <p>
* This property does not define global responses for all operations.
*
* @return The value of the <property>responses</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -641,8 +719,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>responses</property>.
+ *
* <p>
* An object to hold responses that can be used across operations.
+ *
+ * <p>
* This property does not define global responses for all operations.
*
* @param responses The new value for the <property>responses</property> property on this bean.
@@ -655,8 +736,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>responses</property>.
+ *
* <p>
* An object to hold responses that can be used across operations.
+ *
+ * <p>
* This property does not define global responses for all operations.
*
* @param name The response name.
@@ -683,11 +767,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>securityDefinitions</property>.
+ *
* <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;
@@ -695,6 +781,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>securityDefinitions</property>.
+ *
* <p>
* Security scheme definitions that can be used across the specification.
*
@@ -708,6 +795,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>securityDefinitions</property>.
+ *
* <p>
* Security scheme definitions that can be used across the specification.
*
@@ -735,8 +823,11 @@ 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.
+ *
+ * <p>
* 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.
@@ -749,8 +840,11 @@ 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.
+ *
+ * <p>
* 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.
@@ -765,8 +859,11 @@ 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.
+ *
+ * <p>
* 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.
@@ -797,8 +894,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>tags</property>.
+ *
* <p>
* A list of tags used by the specification with additional metadata.
+ *
+ * <p>
* 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.
@@ -813,8 +913,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>tags</property>.
+ *
* <p>
* A list of tags used by the specification with additional metadata.
+ *
+ * <p>
* 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.
@@ -831,8 +934,11 @@ public class Swagger extends SwaggerElement {
/**
* Bean property adder: <property>tags</property>.
+ *
* <p>
* A list of tags used by the specification with additional metadata.
+ *
+ * <p>
* 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.
@@ -871,11 +977,13 @@ public class Swagger extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
+ *
* <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;
@@ -883,6 +991,7 @@ public class Swagger extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
+ *
* <p>
* Additional external documentation.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 89f251f..9e96614 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
@@ -61,10 +61,10 @@ public class SwaggerBuilder {
*
* @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}.
- * <br>Strings must be valid URIs.
- * <br>URIs defined by {@link UriResolver} can be used for values.
+ * The {@link Contact#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.
* @param email The {@link Contact#email(String)} attribute.
* @return The new element.
*/
@@ -86,10 +86,10 @@ public class SwaggerBuilder {
* 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 {@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.
* @return The new element.
*/
public static final ExternalDocumentation externalDocumentation(Object url) {
@@ -100,10 +100,11 @@ public class SwaggerBuilder {
* 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.
+ * @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.
* @param description The {@link ExternalDocumentation#description(String)} attribute.
* @return The new element.
*/
@@ -262,8 +263,8 @@ public class SwaggerBuilder {
/**
* Creates an {@link ResponseInfo} element with the specified {@link ResponseInfo#description(String)} attribute.
- * @param description The {@link ResponseInfo#description(String)} attribute.
*
+ * @param description The {@link ResponseInfo#description(String)} attribute.
* @return The new element.
*/
public static final ResponseInfo responseInfo(String description) {
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/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 6215ae0..3e97616 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,8 +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.
*
@@ -53,6 +53,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* Required. The name of the tag.
*
@@ -64,6 +65,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* Required. The name of the tag.
*
@@ -87,13 +89,16 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>description</property>.
+ *
* <p>
* A short description for the tag.
+ *
+ * <p>
* <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;
@@ -101,8 +106,11 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>description</property>.
+ *
* <p>
* A short description for the tag.
+ *
+ * <p>
* <a class="doclink" href="https://help.github.com/articles/github-flavored-markdown">GFM syntax</a> can be used
* for rich text representation.
*
@@ -126,11 +134,12 @@ public class Tag extends SwaggerElement {
/**
* Bean property getter: <property>externalDocs</property>.
+ *
* <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;
@@ -138,6 +147,7 @@ public class Tag extends SwaggerElement {
/**
* Bean property setter: <property>externalDocs</property>.
+ *
* <p>
* Additional external documentation for this tag.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
index 247ecda..39b7e53 100644
--- a/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
+++ b/juneau-core/src/main/java/org/apache/juneau/dto/swagger/Xml.java
@@ -16,6 +16,7 @@ import org.apache.juneau.annotation.*;
/**
* A metadata object that allows for more fine-tuned XML model definitions.
+ *
* <p>
* When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be
* used to add that information.
@@ -47,8 +48,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>name</property>.
+ *
* <p>
* Replaces the name of the element/attribute used for the described schema property.
+ *
+ * <p>
* When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
* within the list.
* When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
@@ -63,8 +67,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>name</property>.
+ *
* <p>
* Replaces the name of the element/attribute used for the described schema property.
+ *
+ * <p>
* When defined within the Items Object (<code>items</code>), it will affect the name of the individual XML elements
* within the list.
* When defined alongside <code>type</code> being array (outside the <code>items</code>), it will affect the
@@ -91,6 +98,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>namespace</property>.
+ *
* <p>
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
*
@@ -102,6 +110,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>namespace</property>.
+ *
* <p>
* The URL of the namespace definition. Value SHOULD be in the form of a URL.
*
@@ -125,6 +134,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>prefix</property>.
+ *
* <p>
* The prefix to be used for the name.
*
@@ -136,6 +146,7 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>prefix</property>.
+ *
* <p>
* The prefix to be used for the name.
*
@@ -159,8 +170,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>attribute</property>.
+ *
* <p>
* Declares whether the property definition translates to an attribute instead of an element.
+ *
+ * <p>
* Default value is <jk>false</jk>.
*
* @return The value of the <property>attribute</property> property on this bean, or <jk>null</jk> if it is not set.
@@ -171,8 +185,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>attribute</property>.
+ *
* <p>
* Declares whether the property definition translates to an attribute instead of an element.
+ *
+ * <p>
* Default value is <jk>false</jk>.
*
* @param attribute The new value for the <property>attribute</property> property on this bean.
@@ -195,8 +212,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property getter: <property>wrapped</property>.
+ *
* <p>
* MAY be used only for an array definition.
+ *
+ * <p>
* Signifies whether the array is wrapped (for example,
* <code><books><book/><book/><books></code>) or unwrapped
* (<code><book/><book/></code>).
@@ -212,8 +232,11 @@ public class Xml extends SwaggerElement {
/**
* Bean property setter: <property>wrapped</property>.
+ *
* <p>
* MAY be used only for an array definition.
+ *
+ * <p>
* Signifies whether the array is wrapped (for example,
* <code><books><book/><book/><books></code>) or unwrapped
* (<code><book/><book/></code>).
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
index 7c7110f..15e774b 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/Encoder.java
@@ -18,8 +18,10 @@ import java.io.*;
* Used for enabling decompression on requests and compression on responses, such as support for GZIP compression.
*
* <h5 class='section'>Description:</h5>
+ *
* <p>
* Used to wrap input and output streams within compression/decompression streams.
+ *
* <p>
* Encoders are registered with <code>RestServlets</code> through the <ja>@RestResource.encoders()</ja> annotation.
*/
@@ -44,8 +46,8 @@ public abstract class Encoder {
public abstract OutputStream getOutputStream(OutputStream os) throws IOException;
/**
- * Returns the codings in <code>Content-Encoding</code> and <code>Accept-Encoding</code> headers
- * that this encoder handles (e.g. <js>"gzip"</js>).
+ * Returns the codings in <code>Content-Encoding</code> and <code>Accept-Encoding</code> headers that this encoder
+ * handles (e.g. <js>"gzip"</js>).
*
* @return The codings that this encoder handles.
*/
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
index ae3128e..c75be25 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroup.java
@@ -21,22 +21,25 @@ import org.apache.juneau.http.*;
* Represents the group of {@link Encoder encoders} keyed by codings.
*
* <h5 class='section'>Description:</h5>
+ *
* <p>
* Maintains a set of encoders and the codings that they can handle.
+ *
* <p>
- * The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then
- * used to find appropriate encoders for specific <code>Accept-Encoding</code>
- * and <code>Content-Encoding</code> header values.
+ * The {@link #getEncoderMatch(String)} and {@link #getEncoder(String)} methods are then used to find appropriate
+ * encoders for specific <code>Accept-Encoding</code> and <code>Content-Encoding</code> header values.
*
* <h6 class='topic'>Match ordering</h6>
* <p>
* Encoders are matched against <code>Accept-Encoding</code> strings in the order they exist in this group.
+ *
* <p>
* Adding new entries will cause the entries to be prepended to the group.
* This allows for previous encoders to be overridden through subsequent calls.
+ *
* <p>
* For example, calling <code>groupBuilder.append(E1.<jk>class</jk>,E2.<jk>class</jk>).append(E3.<jk>class</jk>,
- * E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
+ * E4.<jk>class</jk>)</code> will result in the order <code>E3, E4, E1, E2</code>.
*
* <h5 class='section'>Example:</h5>
* <p class='bcode'>
@@ -84,9 +87,11 @@ public final class EncoderGroup {
/**
* Returns the coding string for the matching encoder that can handle the specified <code>Accept-Encoding</code>
- * or <code>Content-Encoding</code> header value.
+ * or <code>Content-Encoding</code> header value.
+ *
* <p>
* Returns <jk>null</jk> if no encoders can handle it.
+ *
* <p>
* This method is fully compliant with the RFC2616/14.3 and 14.11 specifications.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
index 32958ec..db54070 100644
--- a/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
+++ b/juneau-core/src/main/java/org/apache/juneau/encoders/EncoderGroupBuilder.java
@@ -88,6 +88,7 @@ public class EncoderGroupBuilder {
/**
* Creates a new {@link EncoderGroup} object using a snapshot of the settings defined in this builder.
+ *
* <p>
* This method can be called multiple times to produce multiple encoder groups.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
index 71358d2..15e6ae4 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlBeanPropertyMeta.java
@@ -86,8 +86,9 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should be serialized as plain text instead of HTML.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#asPlainText()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#asPlainText()} is
+ * <jk>true</jk>.
*/
protected boolean isAsPlainText() {
return asPlainText;
@@ -96,8 +97,9 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not be serialized as an HTML table.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTables()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTables()} is
+ * <jk>true</jk>.
*/
protected boolean isNoTables() {
return noTables;
@@ -106,8 +108,9 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns whether this bean property should not include table headers when serialized as an HTML table.
*
- * @return <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTableHeaders()} is
- * <jk>true</jk>.
+ * @return
+ * <jk>true</jk> if the the {@link Html} annotation is specified, and {@link Html#noTableHeaders()} is
+ * <jk>true</jk>.
*/
public boolean isNoTableHeaders() {
return noTableHeaders;
@@ -115,6 +118,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Returns the render class for rendering the style and contents of this property value in HTML.
+ *
* <p>
* This value is specified via the {@link Html#render()} annotation.
*
@@ -126,6 +130,7 @@ public final class HtmlBeanPropertyMeta extends BeanPropertyMetaExtended {
/**
* Adds a hyperlink to this value in HTML.
+ *
* <p>
* This value is specified via the {@link Html#link()} annotation.
*
http://git-wip-us.apache.org/repos/asf/incubator-juneau/blob/19c566dd/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
----------------------------------------------------------------------
diff --git a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
index 0f46b1e..0668b7c 100644
--- a/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
+++ b/juneau-core/src/main/java/org/apache/juneau/html/HtmlDocSerializerContext.java
@@ -18,6 +18,7 @@ import org.apache.juneau.*;
/**
* Properties associated with the {@link HtmlDocSerializer} class.
+ *
* <p>
* These are typically specified via <ja>@RestResource.properties()</ja> and <ja>@RestMethod.properties()</ja>
* annotations, although they can also be set programmatically via the <code>RestResponse.setProperty()</code> method.
@@ -34,6 +35,7 @@ import org.apache.juneau.*;
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* Note that shortcut annotations are also provided for these particular settings:
* <p class='bcode'>
@@ -76,6 +78,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page title.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.title"</js>
@@ -83,13 +86,13 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies the text for the title that shows up in the header section of the page generated by the basic template.
*
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
- * </p>
* <p class='bcode'>
* <ja>@RestResource</ja>(
* messages=<js>"nls/AddressBookResource"</js>,
@@ -99,16 +102,16 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...with this property in <code>AddressBookResource.properties</code>...
- * </p>
* <p class='bcode'>
* title = <js>AddressBook sample resource</js>
* </p>
* <p>
* ...to produce this title on the HTML page...
- * </p>
* <img class='bordered' src='doc-files/HTML_TITLE.png'>
+ *
* <p>
* Shortcuts on <ja>@RestResource</ja> are also provided for this setting:
* <p class='bcode'>
@@ -127,6 +130,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -134,6 +138,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page description.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.description"</js>
@@ -141,6 +146,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies the text for the subtitle that shows up in the header section of the page generated by the basic
* template.
@@ -159,16 +165,17 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...with this property in <code>AddressBookResource.properties</code>...
- * </p>
* <p class='bcode'>
* description = <js>Simple address book POJO sample resource</js>
* </p>
+ *
* <p>
* ...to produce this description on the HTML page...
- * </p>
* <img class='bordered' src='doc-files/HTML_DESCRIPTION.png'>
+ *
* <p>
* Shortcuts on <ja>@RestResource</ja> are also provided for this setting:
* <p class='bcode'>
@@ -187,6 +194,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -194,6 +202,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page branding.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlSerializer.branding"</js>
@@ -201,9 +210,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies arbitrary HTML for the header that can be used for adding custom branding to the page generated by the
- * basic template.
+ * basic template.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -211,6 +222,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Header section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.header"</js>
@@ -218,6 +230,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to override the contents of the header section on the HTML page.
* The header section normally contains the title and description at the top of the page.
@@ -230,9 +243,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_title} and {@link #HTMLDOC_description} properties are
* ignored.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -240,6 +255,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Page links.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.links.map"</js>
@@ -247,12 +263,16 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> empty map
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds a list of hyperlinks immediately under the title and description but above the content of the page.
+ *
* <p>
* This can be used to provide convenient hyperlinks when viewing the REST interface from a browser.
+ *
* <p>
* The value is a JSON object string where the keys are anchor text and the values are URLs.
+ *
* <p>
* Relative URLs are considered relative to the servlet path.
* For example, if the servlet path is <js>"http://localhost/myContext/myServlet"</js>, and the
@@ -264,7 +284,6 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <h5 class='section'>Example:</h5>
* <p>
* The <code>AddressBookResource</code> sample class uses this property...
- * </p>
* <p class='bcode'>
* <ja>@RestResource</ja>(
* properties={
@@ -274,10 +293,11 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* ...to produce this list of links on the HTML page...
- * </p>
* <img class='bordered' src='doc-files/HTML_LINKS.png'>
+ *
* <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
@@ -288,6 +308,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* <jk>public class</jk> AddressBookResource <jk>extends</jk> RestServletJenaDefault {
* </p>
+ *
* <p>
* Values that start with <js>'<'</js> are assumed to be HTML and rendered as-is.
*/
@@ -300,6 +321,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Nav section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nav"</js>
@@ -307,6 +329,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to override the contents of the nav section on the HTML page.
* The nav section normally contains the page links at the top of the page.
@@ -319,8 +342,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* When this property is specified, the {@link #HTMLDOC_links} property is ignored.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -328,6 +353,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Aside section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.aside"</js>
@@ -335,10 +361,12 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to specify the contents of the aside section on the HTML page.
* The aside section floats on the right of the page for providing content supporting the serialized content of
* the page.
+ *
* <p>
* By default, the aside section is empty.
*
@@ -350,6 +378,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -357,6 +386,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Footer section contents.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.footer"</js>
@@ -364,8 +394,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>null</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to specify the contents of the footer section on the HTML page.
+ *
* <p>
* By default, the footer section is empty.
*
@@ -377,6 +409,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -384,6 +417,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> No-results message.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.noResultsMessage"</js>
@@ -391,6 +425,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <js>"<p>no results</p>"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Allows you to specify the string message used when trying to serialize an empty array or empty list.
*
@@ -402,6 +437,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* )
* )
* </p>
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -409,6 +445,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Prevent word wrap on page.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.nowrap"</js>
@@ -416,6 +453,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <jk>false</jk>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds <js>"* {white-space:nowrap}"</js> to the CSS instructions on the page to prevent word wrapping.
*/
@@ -423,6 +461,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> Stylesheet URL.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.cssUrl"</js>
@@ -430,11 +469,14 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <js>"style.css"</js>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds a link to the specified stylesheet URL.
+ *
* <p>
* If not specified, defaults to the built-in stylesheet located at <js>"style.css"</js>.
* Note that this stylesheet is controlled by the <code><ja>@RestResource</ja>.stylesheet()</code> annotation.
+ *
* <p>
* A value of <js>"NONE"</js> can be used to represent no value to differentiate it from an empty string.
*/
@@ -442,6 +484,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> CSS code.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.css.list"</js>
@@ -449,6 +492,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> empty list
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Adds the specified CSS instructions to the HTML page.
*
@@ -461,6 +505,8 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* }
* )
* </p>
+ *
+ * <p>
* A shortcut on <ja>@RestResource</ja> is also provided for this setting:
* <p class='bcode'>
* <ja>@RestResource</ja>(
@@ -479,6 +525,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* <b>Configuration property:</b> HTML document template.
+ *
* <p>
* <ul>
* <li><b>Name:</b> <js>"HtmlDocSerializer.template"</js>
@@ -486,8 +533,10 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
* <li><b>Default:</b> <code>HtmlDocTemplateBasic.<jk>class</jk></code>
* <li><b>Session-overridable:</b> <jk>true</jk>
* </ul>
+ *
* <p>
* Specifies the template to use for serializing the page.
+ *
* <p>
* By default, the {@link HtmlDocTemplateBasic} class is used to construct the contents of the HTML page, but
* can be overridden with your own custom implementation class.
@@ -512,6 +561,7 @@ public final class HtmlDocSerializerContext extends HtmlSerializerContext {
/**
* Constructor.
+ *
* <p>
* Typically only called from {@link PropertyStore#getContext(Class)}.
*