http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/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 366a9bf..fe5dfb1 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaArray.html @@ -132,20 +132,23 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.32">SchemaArray</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.35">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 + <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> - </ul> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + </li> </ul></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -298,7 +301,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.39">SchemaArray</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaArray.html#line.42">SchemaArray</a>()</pre> <div class="block">Default constructor.</div> </li> </ul> @@ -308,7 +311,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.46">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.49">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> @@ -330,7 +333,7 @@ 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.56">addAll</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="../../../../../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.59">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>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/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 9ad0d09..a4ea268 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaMap.html @@ -122,25 +122,32 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.43">SchemaMap</a> +<pre>public abstract class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.50">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> Subclasses must implement one of the following methods to load schemas from external sources: <ul class='spaced-list'> - <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> - If schemas should be loaded from readers and automatically parsed. - <li><a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#load-java.net.URI-"><code>load(URI)</code></a> - If you want control over construction of <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects. + <li> + <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#getReader-java.net.URI-"><code>getReader(URI)</code></a> - If schemas should be loaded from readers and automatically parsed. + <li> + <a href="../../../../../org/apache/juneau/dto/jsonschema/SchemaMap.html#load-java.net.URI-"><code>load(URI)</code></a> - If you want control over construction of <a href="../../../../../org/apache/juneau/dto/jsonschema/Schema.html" title="class in org.apache.juneau.dto.jsonschema"><code>Schema</code></a> objects. </ul> <h6 class='topic'>Additional Information</h6> <ul class='doctree'> - <li class='link'><a class='doclink' href='../../../../../overview-summary.html#DTOs'>Juneau Data Transfer Objects + <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> - </ul> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + </li> </ul></div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -276,7 +283,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.43">SchemaMap</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaMap.html#line.50">SchemaMap</a>()</pre> </li> </ul> </li> @@ -293,12 +300,16 @@ 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.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> +<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.71">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. + + <p> 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> 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>. Strings must be valid URIs. + <p> URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div> <dl> @@ -319,8 +330,9 @@ 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.85">add</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="../../../../../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.97">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> @@ -339,9 +351,12 @@ 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.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> +<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.121">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. + + <p> 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 @@ -360,9 +375,12 @@ 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.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> +<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.150">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. + + <p> It's up to the implementer to decide where these come from. + <p> The default implementation returns <jk>null</jk>.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/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 05e77ba..3eb588a 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaProperty.html @@ -111,20 +111,23 @@ </dl> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.30">SchemaProperty</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.33">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 + <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> - </ul> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + </li> </ul></div> </li> </ul> @@ -217,7 +220,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.35">SchemaProperty</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.38">SchemaProperty</a>()</pre> <div class="block">Default constructor.</div> </li> </ul> @@ -227,7 +230,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.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> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.45">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> @@ -241,7 +244,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.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, +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaProperty.html#line.55">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/1b5bde65/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 92504d5..2f94fd8 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html @@ -112,9 +112,10 @@ <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.39">SchemaPropertySimpleArray</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.44">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> An instance of this object is equivalent to calling... @@ -128,13 +129,17 @@ 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 + <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> - </ul> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + </li> </ul></div> </li> </ul> @@ -217,7 +222,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.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, +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaPropertySimpleArray.html#line.52">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/1b5bde65/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 95fda26..d30114a 100644 --- a/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html +++ b/content/site/apidocs/org/apache/juneau/dto/jsonschema/SchemaRef.html @@ -107,9 +107,10 @@ <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.39">SchemaRef</a> +<pre>public class <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.44">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> An instance of this object is equivalent to calling... @@ -119,13 +120,17 @@ 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 + <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> - </ul> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.JsonSchema'>JSON-Schema</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.jsonschema</a> + </li> </ul></div> </li> </ul> @@ -207,11 +212,13 @@ 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.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> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/jsonschema/SchemaRef.html#line.58">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>. Strings must be valid URIs. + <p> URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div> <dl> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/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 050cb4a..45ebc9f 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 @@ -213,8 +213,7 @@ <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 + <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> @@ -387,15 +386,22 @@ The bean classes that make up the model are as follows: </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 + <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 + <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. - <li><a href="../../../../../org/apache/juneau/dto/jsonschema/JsonTypeArray.html" title="class in org.apache.juneau.dto.jsonschema"><code>JsonTypeArray</code></a> - An array of <code>JsonType</code> objects. + <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. + <li> + <a href="../../../../../org/apache/juneau/dto/jsonschema/JsonTypeArray.html" title="class in org.apache.juneau.dto.jsonschema"><code>JsonTypeArray</code></a> - An array of <code>JsonType</code> objects. </ul> </div> @@ -614,6 +620,7 @@ 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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/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 cf1f344..622b80d 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.47">Contact</a> +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.52">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,12 +129,17 @@ 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 + <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> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> + </li> </ul></div> </li> </ul> @@ -260,7 +265,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.47">Contact</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/Contact.html#line.52">Contact</a>()</pre> </li> </ul> </li> @@ -277,8 +282,9 @@ 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.60">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.66">getName</a>()</pre> <div class="block">Bean property getter: <property>name</property>. + <p> The identifying name of the contact person/organization.</div> <dl> @@ -293,8 +299,9 @@ 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.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> +<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.79">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> <dl> @@ -311,7 +318,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.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> +<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.90">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> @@ -327,8 +334,9 @@ 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.94">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.102">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> <dl> @@ -343,11 +351,13 @@ 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.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> +<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">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>. Strings must be valid URIs. + <p> URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div> <dl> @@ -364,7 +374,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.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> +<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.130">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> @@ -380,8 +390,9 @@ 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.131">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.142">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> <dl> @@ -396,8 +407,9 @@ 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.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> +<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.155">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> <dl> @@ -414,7 +426,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.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> +<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.166">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/1b5bde65/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 48b5e9c..c36b3f8 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.46">ExternalDocumentation</a> +public class <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.51">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,12 +128,17 @@ 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 + <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> - <li class='jp'><a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> + <ul> + <li class='sublink'> + <a class='doclink' href='../../../../../overview-summary.html#DTOs.Swagger'>Swagger</a> + </ul> + </li> + <li class='jp'> + <a class='doclink' href='package-summary.html#TOC'>org.apache.juneau.dto.swagger</a> + </li> </ul></div> </li> </ul> @@ -241,7 +246,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.46">ExternalDocumentation</a>()</pre> +<pre>public <a href="../../../../../src-html/org/apache/juneau/dto/swagger/ExternalDocumentation.html#line.51">ExternalDocumentation</a>()</pre> </li> </ul> </li> @@ -258,14 +263,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.59">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.65">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> @@ -275,8 +280,9 @@ 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.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> +<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.78">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> <dl> @@ -293,7 +299,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.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> +<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.89">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> @@ -309,13 +315,16 @@ 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.98">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.108">getUrl</a>()</pre> <div class="block">Bean property getter: <property>url</property>. + <p> Required. The URL for the target documentation. + <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>. Strings must be valid URIs. + <p> URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div> <dl> @@ -330,11 +339,13 @@ 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.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> +<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.125">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>. Strings must be valid URIs. + <p> URIs defined by <a href="../../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> can be used for values.</div> <dl> @@ -351,7 +362,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.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> +<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.136">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>
