http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html index 37ef0ca..366a9bf 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html @@ -132,16 +132,18 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.30">SchemaArray</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.32">SchemaArray</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.html?is-external=true"; title="class or interface in java.util">LinkedList</a><<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>></pre> <div class="block">Represents a list of <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects. <p> <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.JsonSchema'>JSON-Schema</a> + <li class='sublink'><a class='doclink' + href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> </ul> <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> </ul></div> @@ -209,8 +211,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaArray.html" title="class in org.apache.juneau.dto.jsonschema">SchemaArray</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaArray.html#addAll-org.apache.juneau.dto.jsonschema.Schema...-">addAll</a></span>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</code> -<div class="block">Convenience method for adding one or more <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects to - this array.</div> +<div class="block">Convenience method for adding one or more <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects to this array.</div> </td> </tr> </table> @@ -297,7 +298,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <ul class="blockList"> <li class="blockList"> <h4>SchemaArray</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.37">SchemaArray</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.39">SchemaArray</a>()</pre> <div class="block">Default constructor.</div> </li> </ul> @@ -307,7 +308,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <ul class="blockListLast"> <li class="blockList"> <h4>SchemaArray</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.44">SchemaArray</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.46">SchemaArray</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> <div class="block">Constructor with predefined types to add to this list.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -329,9 +330,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedList.h <ul class="blockListLast"> <li class="blockList"> <h4>addAll</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaArray.html" title="class in org.apache.juneau.dto.jsonschema">SchemaArray</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.55">addAll</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> -<div class="block">Convenience method for adding one or more <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects to - this array.</div> +<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaArray.html" title="class in org.apache.juneau.dto.jsonschema">SchemaArray</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.56">addAll</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> +<div class="block">Convenience method for adding one or more <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects to this array.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>schemas</code> - The <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects to add to this array.</dd>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html index b963513..9ad0d09 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html @@ -122,7 +122,7 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.41">SchemaMap</a> +<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.43">SchemaMap</a> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/ConcurrentHashMap.html?is-external=true"; title="class or interface in java.util.concurrent">ConcurrentHashMap</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a>,<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>></pre> <div class="block">A container for retrieving JSON <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects by URI. <p> @@ -134,9 +134,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <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.JsonSchema'>JSON-Schema</a> + <li class='sublink'><a class='doclink' + href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> </ul> <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> </ul></div> @@ -211,7 +213,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html" title="class in org.apache.juneau.dto.jsonschema">SchemaMap</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#add-org.apache.juneau.dto.jsonschema.Schema...-">add</a></span>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</code> -<div class="block">Convenience method for prepopulating this map with the specified schemas.</div> +<div class="block">Convenience method for pre-populating this map with the specified schemas.</div> </td> </tr> <tr id="i1" class="rowColor"> @@ -274,7 +276,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <ul class="blockListLast"> <li class="blockList"> <h4>SchemaMap</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.41">SchemaMap</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.43">SchemaMap</a>()</pre> </li> </ul> </li> @@ -291,7 +293,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <ul class="blockList"> <li class="blockList"> <h4>get</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.58">get</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.60">get</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> <div class="block">Return the <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> object at the specified URI. If this schema object has not been loaded yet, calls <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#load-java.net.URI-"><code>load(URI)</code></a>. <p> @@ -317,8 +319,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <ul class="blockList"> <li class="blockList"> <h4>add</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html" title="class in org.apache.juneau.dto.jsonschema">SchemaMap</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.83">add</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> -<div class="block">Convenience method for prepopulating this map with the specified schemas. +<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html" title="class in org.apache.juneau.dto.jsonschema">SchemaMap</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.85">add</a>(<a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a>... schemas)</pre> +<div class="block">Convenience method for pre-populating this map with the specified schemas. <p> The schemas passed in through this method MUST have their ID properties set.</div> <dl> @@ -337,12 +339,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <ul class="blockList"> <li class="blockList"> <h4>load</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.103">load</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.106">load</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri)</pre> <div class="block">Subclasses must implement either this method or <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> to load the schema with the specified URI. It's up to the implementer to decide where these come from. <p> The default implementation calls <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> and parses the schema document. - If <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an unreachable document.</div> + If <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> returns <jk>null</jk>, this method returns <jk>null</jk> indicating this is an + unreachable document.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>uri</code> - The URI to load the schema from.</dd> @@ -357,7 +360,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/concurrent/C <ul class="blockListLast"> <li class="blockList"> <h4>getReader</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.129">getReader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri)</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Reader.html?is-external=true"; title="class or interface in java.io">Reader</a> <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.132">getReader</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> uri)</pre> <div class="block">Subclasses must implement either this method or <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#load-java.net.URI-"><code>load(URI)</code></a> to load the schema with the specified URI. It's up to the implementer to decide where these come from. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html index a86e77a..05e77ba 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html @@ -111,16 +111,18 @@ </dl> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.28">SchemaProperty</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.30">SchemaProperty</a> extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a></pre> <div class="block">Represents a JSON property in the JSON-Schema core specification. <p> <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.JsonSchema'>JSON-Schema</a> + <li class='sublink'><a class='doclink' + href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> </ul> <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> </ul></div> @@ -215,7 +217,7 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" ti <ul class="blockList"> <li class="blockList"> <h4>SchemaProperty</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.33">SchemaProperty</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.35">SchemaProperty</a>()</pre> <div class="block">Default constructor.</div> </li> </ul> @@ -225,7 +227,7 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" ti <ul class="blockList"> <li class="blockList"> <h4>SchemaProperty</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.40">SchemaProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.42">SchemaProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> <div class="block">Convenience constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -239,7 +241,7 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" ti <ul class="blockListLast"> <li class="blockList"> <h4>SchemaProperty</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.50">SchemaProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.52">SchemaProperty</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, <a href="../../../../../org/apache/juneau/dto/jsonschema/JsonType.html" title="enum in org.apache.juneau.dto.jsonschema">JsonType</a> type)</pre> <div class="block">Convenience constructor.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html index db27223..92504d5 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html @@ -112,7 +112,7 @@ <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.37">SchemaPropertySimpleArray</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.39">SchemaPropertySimpleArray</a> extends <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaProperty.html" title="class in org.apache.juneau.dto.jsonschema">SchemaProperty</a></pre> <div class="block">Convenience class for representing a property that's an array of simple types. <p> @@ -128,9 +128,11 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaProperty. <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.JsonSchema'>JSON-Schema</a> + <li class='sublink'><a class='doclink' + href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> </ul> <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> </ul></div> @@ -215,7 +217,7 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaProperty. <ul class="blockListLast"> <li class="blockList"> <h4>SchemaPropertySimpleArray</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.45">SchemaPropertySimpleArray</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.47">SchemaPropertySimpleArray</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name, <a href="../../../../../org/apache/juneau/dto/jsonschema/JsonType.html" title="enum in org.apache.juneau.dto.jsonschema">JsonType</a> elementType)</pre> <div class="block">Constructor.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html index 37ae51d..95fda26 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html @@ -107,7 +107,7 @@ <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.37">SchemaRef</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.39">SchemaRef</a> extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema">Schema</a></pre> <div class="block">Convenience class for representing a schema reference such as <js>"{'$ref':'/url/to/ref'}"</js>. <p> @@ -119,9 +119,11 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" ti <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.JsonSchema'>JSON-Schema</a> + <li class='sublink'><a class='doclink' + href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> </ul> <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> </ul></div> @@ -205,7 +207,7 @@ extends <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" ti <ul class="blockListLast"> <li class="blockList"> <h4>SchemaRef</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.49">SchemaRef</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.51">SchemaRef</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> <div class="block">Constructor. <p> The value can be of any of the following types: <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang"><code>String</code></a>. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html index e158820..050cb4a 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/package-summary.html @@ -211,11 +211,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 <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a> and <a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a> 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 <a href="../../../../../org/apache/juneau/json/JsonSerializer.html" title="class in org.apache.juneau.json"><code>JsonSerializer</code></a> and + <a href="../../../../../org/apache/juneau/json/JsonParser.html" title="class in org.apache.juneau.json"><code>JsonParser</code></a> 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> <!-- ======================================================================================================== --> @@ -241,10 +245,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>, @@ -382,8 +388,10 @@ </p> <ul class='spaced-list'> <li><a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> - Top level schema object. - <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaProperty.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaProperty</code></a> - A subclass of <code>Schema</code> for representing properties. - <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaPropertySimpleArray</code></a> - A convenience subclass of <code>SchemaProperty</code> for representing properties of simple array types. + <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaProperty.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaProperty</code></a> - A subclass of <code>Schema</code> for + representing properties. + <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaPropertySimpleArray</code></a> - A convenience subclass of + <code>SchemaProperty</code> for representing properties of simple array types. <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaRef.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaRef</code></a> - Represents a URI reference to another schema. <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaArray.html" title="class in org.apache.juneau.dto.jsonschema"><code>SchemaArray</code></a> - An array of <code>Schema</code> objects. <li><a href="../../../../../org/apache/juneau/dto/jsonschema/JsonType.html" title="enum in org.apache.juneau.dto.jsonschema"><code>JsonType</code></a> - An enum of possible JSON data types. @@ -532,7 +540,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> @@ -602,14 +611,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> @@ -629,7 +639,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-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html b/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html index eaaf3e1..cf1f344 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/Contact.html @@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="name,url,email") -public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.46">Contact</a> +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.47">Contact</a> extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre> <div class="block">Contact information for the exposed API. @@ -129,7 +129,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <h6 class='topic'>Additional Information</h6> <ul class='doctree'> - <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a> + <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects + (org.apache.juneau.dto)</a> <ul> <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a> </ul> @@ -259,7 +260,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockListLast"> <li class="blockList"> <h4>Contact</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.46">Contact</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.47">Contact</a>()</pre> </li> </ul> </li> @@ -276,7 +277,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>getName</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.59">getName</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.60">getName</a>()</pre> <div class="block">Bean property getter: <property>name</property>. <p> The identifying name of the contact person/organization.</div> @@ -292,7 +293,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>setName</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.71">setName</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.72">setName</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> <div class="block">Bean property setter: <property>name</property>. <p> The identifying name of the contact person/organization.</div> @@ -310,7 +311,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>name</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.82">name</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.83">name</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> <div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setName-java.lang.String-"><code>setName(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -326,7 +327,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>getUrl</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.93">getUrl</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.94">getUrl</a>()</pre> <div class="block">Bean property getter: <property>url</property>. <p> The URL pointing to the contact information. MUST be in the format of a URL.</div> @@ -342,7 +343,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>setUrl</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.108">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.109">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> <div class="block">Bean property setter: <property>url</property>. <p> The value can be of any of the following types: <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang"><code>String</code></a>. @@ -363,7 +364,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>url</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.119">url</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.120">url</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> <div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setUrl-java.lang.Object-"><code>setUrl(Object)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -379,7 +380,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>getEmail</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.130">getEmail</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.131">getEmail</a>()</pre> <div class="block">Bean property getter: <property>email</property>. <p> The email address of the contact person/organization. MUST be in the format of an email address.</div> @@ -395,7 +396,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>setEmail</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.142">setEmail</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.143">setEmail</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</pre> <div class="block">Bean property setter: <property>email</property>. <p> The email address of the contact person/organization. MUST be in the format of an email address.</div> @@ -413,7 +414,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockListLast"> <li class="blockList"> <h4>email</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.153">email</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.154">email</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> email)</pre> <div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/Contact.html#setEmail-java.lang.String-"><code>setEmail(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html b/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html index 8431d15..48b5e9c 100644 --- a/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html +++ b/content/site/apidocs/org/apache/juneau/dto/swagger/ExternalDocumentation.html @@ -114,7 +114,7 @@ var activeTableTab = "activeTableTab"; <hr> <br> <pre><a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">@Bean</a>(<a href="../../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a>="description,url") -public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.45">ExternalDocumentation</a> +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.46">ExternalDocumentation</a> extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.html" title="class in org.apache.juneau.dto.swagger">SwaggerElement</a></pre> <div class="block">Allows referencing an external resource for extended documentation. @@ -128,7 +128,8 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <h6 class='topic'>Additional Information</h6> <ul class='doctree'> - <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects (org.apache.juneau.dto)</a> + <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects + (org.apache.juneau.dto)</a> <ul> <li class='sublink'><a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a> </ul> @@ -240,7 +241,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockListLast"> <li class="blockList"> <h4>ExternalDocumentation</h4> -<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.45">ExternalDocumentation</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.46">ExternalDocumentation</a>()</pre> </li> </ul> </li> @@ -257,13 +258,14 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>getDescription</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.57">getDescription</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.59">getDescription</a>()</pre> <div class="block">Bean property getter: <property>description</property>. <p> A short description of the target documentation. GFM syntax can be used for rich text representation.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> -<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not set.</dd> +<dd>The value of the <property>description</property> property on this bean, or <jk>null</jk> if it is not + set.</dd> </dl> </li> </ul> @@ -273,7 +275,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>setDescription</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.69">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.71">setDescription</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</pre> <div class="block">Bean property setter: <property>description</property>. <p> A short description of the target documentation. GFM syntax can be used for rich text representation.</div> @@ -291,7 +293,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>description</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.80">description</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.82">description</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> description)</pre> <div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#setDescription-java.lang.String-"><code>setDescription(String)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -307,7 +309,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>getUrl</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.96">getUrl</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net">URI</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.98">getUrl</a>()</pre> <div class="block">Bean property getter: <property>url</property>. <p> Required. The URL for the target documentation. @@ -328,7 +330,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockList"> <li class="blockList"> <h4>setUrl</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.111">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.113">setUrl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> <div class="block">Bean property setter: <property>url</property>. <p> The value can be of any of the following types: <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URI.html?is-external=true"; title="class or interface in java.net"><code>URI</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang"><code>String</code></a>. @@ -349,7 +351,7 @@ extends <a href="../../../../../org/apache/juneau/dto/swagger/SwaggerElement.htm <ul class="blockListLast"> <li class="blockList"> <h4>url</h4> -<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.122">url</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> +<pre>public <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a> <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.124">url</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> url)</pre> <div class="block">Synonym for <a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html#setUrl-java.lang.Object-"><code>setUrl(Object)</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt>
