http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/ObjectMap.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/ObjectMap.html b/content/site/apidocs/org/apache/juneau/ObjectMap.html index 54037f8..54260fd 100644 --- a/content/site/apidocs/org/apache/juneau/ObjectMap.html +++ b/content/site/apidocs/org/apache/juneau/ObjectMap.html @@ -145,7 +145,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa constructor is provided for converting a JSON object string directly into a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util"><code>Map</code></a>. It also contains accessor methods for to avoid common typecasting when accessing elements in a list. - <h6 class='topic'>Examples</h6> + <h6 class='topic'>Example:</h6> <p class='bcode'> <jc>// Construct an empty Map</jc> Map m = <jk>new</jk> ObjectMap(); @@ -2121,28 +2121,27 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>cast</h4> -<pre>public <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> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1152">cast</a>()</pre> +<pre>public <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> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1148">cast</a>()</pre> <div class="block">Converts this map into the class type specified by the <js>"_type"</js> entry value. <p> This method can be used to convert <code>ObjectMap</code> objects to a variety of POJO types. - <dl> - <dt>Example of valid class types:</dt> - <dd> - <p> - An object map can be converted to a bean. - </p> - <p class='bcode'> + + <h6 class='topic'>Examples of valid class types:</h6> + <p> + An object map can be converted to a bean. + </p> + <p class='bcode'> { _type: <js>'com.ibm.sample.addressBook.Person'</js>, name: <js>'John Smith'</js>, ... } - </p> - <p> - It can also be converted into another map type. - </p> - <p class='bcode'> + </p> + <p> + It can also be converted into another map type. + </p> + <p class='bcode'> <jc>// Generic TreeMap (String keys, Object values)</jc> { _type: <js>'java.util.TreeMap'</js>, @@ -2155,11 +2154,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa name: <js>'John Smith'</js>, ... } - </p> - <p> - It can also be converted to Collections objects if map defines an <code>items</code> entry of type array. - </p> - <p class='bcode'> + </p> + <p> + It can also be converted to Collections objects if map defines an <code>items</code> entry of type array. + </p> + <p class='bcode'> <jc>// LinkedList of strings</jc> { _type: <js>'java.util.LinkedList'</js>, @@ -2170,11 +2169,11 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa _type: <js>'java.util.LinkedList<com.ibm.sample.addressBook.Person>'</js>, items: [ { name: <js>'John Smith'</js>, ... }, ... ] } - </p> - <p> - It can also be converted to arrays. - </p> - <p class='bcode'> + </p> + <p> + It can also be converted to arrays. + </p> + <p class='bcode'> <jc>// Array of strings</jc> { _type: <js>'java.lang.String[]'</js>, @@ -2185,25 +2184,22 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa _type: <js>'com.ibm.sample.addressBook.Person[]'</js>, items: [ { name: <js>'John Smith'</js>, ... }, ... ] } - </p> - <p> - It can also be converted to any type that can be handled by the <a href="../../../org/apache/juneau/BeanContext.html#convertToType-java.lang.Object-java.lang.Class-"><code>BeanContext.convertToType(Object, Class)</code></a> method. - In this case, the value is specified by an <code>value</code> entry of any type. - For example, if the bean context has a <a href="../../../org/apache/juneau/transforms/CalendarSwap.html" title="class in org.apache.juneau.transforms"><code>CalendarSwap</code></a> associated with it, it can convert a string value to a calendar. - <p class='bcode'> + </p> + <p> + It can also be converted to any type that can be handled by the <a href="../../../org/apache/juneau/BeanContext.html#convertToType-java.lang.Object-java.lang.Class-"><code>BeanContext.convertToType(Object, Class)</code></a> method. + In this case, the value is specified by an <code>value</code> entry of any type. + For example, if the bean context has a <a href="../../../org/apache/juneau/transforms/CalendarSwap.html" title="class in org.apache.juneau.transforms"><code>CalendarSwap</code></a> associated with it, it can convert a string value to a calendar. + <p class='bcode'> { _type: <js>'java.util.GregorianCalendar'</js>, value: <js>'2001-07-04T15:30:45-05:00'</js> } - </p> - </dd> - <dt>Notes:</dt> - <dd> - <ul> - <li>This method is recursive. It will also recursively convert any descendant entries to POJOs. - </ul> - </dd> - </dl></div> + </p> + + <h6 class='topic'>Notes:</h6> + <ul> + <li>This method is recursive. It will also recursively convert any descendant entries to POJOs. + </ul></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The new Java object of type specified by the <js>"_class"</js> entry value, or this @@ -2217,7 +2213,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>cast</h4> -<pre>public <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> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1164">cast</a>(<a href="../../../org/apache/juneau/BeanDictionary.html" title="class in org.apache.juneau">BeanDictionary</a> typeDictionary)</pre> +<pre>public <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> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1160">cast</a>(<a href="../../../org/apache/juneau/BeanDictionary.html" title="class in org.apache.juneau">BeanDictionary</a> typeDictionary)</pre> <div class="block">Same as <a href="../../../org/apache/juneau/ObjectMap.html#cast--"><code>cast()</code></a>, but first do a lookup for the name in the specified dictionary.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -2234,7 +2230,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>cast</h4> -<pre>public <T> T <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1187">cast</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> +<pre>public <T> T <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1183">cast</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><T> type)</pre> <div class="block">Converts this map into an object of the specified type. <p> The rules are the same as those specified in <a href="../../../org/apache/juneau/ObjectMap.html#cast--"><code>cast()</code></a>. @@ -2260,7 +2256,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>cast</h4> -<pre>public <T> T <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1204">cast</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><T> cm)</pre> +<pre>public <T> T <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1200">cast</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><T> cm)</pre> <div class="block">Same as <a href="../../../org/apache/juneau/ObjectMap.html#cast-java.lang.Class-"><code>cast(Class)</code></a>, except allows you to specify a <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau"><code>ClassMeta</code></a> parameter.</div> <dl> <dt><span class="paramLabel">Type Parameters:</span></dt> @@ -2281,7 +2277,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>toString</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/ObjectMap.html#line.1319">toString</a>(<a href="../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer">WriterSerializer</a> serializer) +<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/ObjectMap.html#line.1315">toString</a>(<a href="../../../org/apache/juneau/serializer/WriterSerializer.html" title="class in org.apache.juneau.serializer">WriterSerializer</a> serializer) throws <a href="../../../org/apache/juneau/serializer/SerializeException.html" title="class in org.apache.juneau.serializer">SerializeException</a></pre> <div class="block">Serialize this object into a string using the specified serializer.</div> <dl> @@ -2300,7 +2296,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>toString</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/ObjectMap.html#line.1327">toString</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/ObjectMap.html#line.1323">toString</a>()</pre> <div class="block">Serialize this object into a JSON string using the <a href="../../../org/apache/juneau/json/JsonSerializer.html#DEFAULT"><code>JsonSerializer.DEFAULT</code></a> serializer.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> @@ -2314,7 +2310,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>serializeTo</h4> -<pre>public <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1344">serializeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> w) +<pre>public <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1340">serializeTo</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> w) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, <a href="../../../org/apache/juneau/serializer/SerializeException.html" title="class in org.apache.juneau.serializer">SerializeException</a></pre> <div class="block">Convenience method for serializing this map to the specified <code>Writer</code> using @@ -2336,7 +2332,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockList"> <li class="blockList"> <h4>keySet</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1350">keySet</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</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>> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1346">keySet</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#keySet--"; title="class or interface in java.util">keySet</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>></code></dd> @@ -2351,7 +2347,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/util/LinkedHashMa <ul class="blockListLast"> <li class="blockList"> <h4>entrySet</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</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>,<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>>> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1360">entrySet</a>()</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Set.html?is-external=true"; title="class or interface in java.util">Set</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.Entry.html?is-external=true"; title="class or interface in java.util">Map.Entry</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>,<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>>> <a href="../../../src-html/org/apache/juneau/ObjectMap.html#line.1356">entrySet</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true#entrySet--"; title="class or interface in java.util">entrySet</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true"; title="class or interface in java.util">Map</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>,<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>></code></dd>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/PropertyNamerDashedLC.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamerDashedLC.html b/content/site/apidocs/org/apache/juneau/PropertyNamerDashedLC.html index e5ef733..2f712b1 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamerDashedLC.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamerDashedLC.html @@ -117,8 +117,8 @@ var activeTableTab = "activeTableTab"; extends <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> implements <a href="../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a></pre> <div class="block">Converts property names to dashed-lower-case format. - <p> - Examples: + + <h6 class='topic'>Examples:</h6> <ul> <li><js>"fooBar"</js> -> <js>"foo-bar"</js> <li><js>"fooBarURL"</js> -> <js>"foo-bar-url"</js> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html b/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html index bfd03be..b6e793e 100644 --- a/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html +++ b/content/site/apidocs/org/apache/juneau/PropertyNamerDefault.html @@ -117,8 +117,8 @@ var activeTableTab = "activeTableTab"; extends <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> implements <a href="../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a></pre> <div class="block">Default property namer. - <p> - Examples: + + <h6 class='topic'>Examples:</h6> <ul> <li><js>"fooBar"</js> -> <js>"fooBar"</js> <li><js>"fooBarURL"</js> -> <js>"fooBarURL"</js> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/Visibility.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/Visibility.html b/content/site/apidocs/org/apache/juneau/Visibility.html index 285a619..9067b5f 100644 --- a/content/site/apidocs/org/apache/juneau/Visibility.html +++ b/content/site/apidocs/org/apache/juneau/Visibility.html @@ -399,9 +399,10 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>isVisible</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.61">isVisible</a>(int mod)</pre> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.62">isVisible</a>(int mod)</pre> <div class="block">Identifies if the specified mod matches this visibility. - Example: + + <h6 class='topic'>Example:</h6> <code> <jsf>PUBLIC</jsf>.isVisible(MyPublicClass.<jk>class</jk>.getModifiers()); <jc>//true</jk> <jsf>PUBLIC</jsf>.isVisible(MyPrivateClass.<jk>class</jk>.getModifiers()); <jc>//false</jk> @@ -422,7 +423,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>isVisible</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.77">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.78">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> <div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -438,7 +439,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>isVisible</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.87">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.88">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> <div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -454,7 +455,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>isVisible</h4> -<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.97">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<pre>public boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.98">isVisible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> <div class="block">Shortcut for <code>isVisible(x.getModifiers());</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -470,7 +471,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>transform</h4> -<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.109">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> x)</pre> +<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.110">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><T> x)</pre> <div class="block">Makes constructor accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> <dl> @@ -488,7 +489,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>transform</h4> -<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.126">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<pre>public <T> <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.127">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> <div class="block">Makes method accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> <dl> @@ -506,7 +507,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>transform</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.143">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> <a href="../../../src-html/org/apache/juneau/Visibility.html#line.144">transform</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> <div class="block">Makes field accessible if it matches the visibility requirements, or returns <jk>null</jk> if it doesn't. Security exceptions thrown on the call to <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/AccessibleObject.html?is-external=true#setAccessible-boolean-"; title="class or interface in java.lang.reflect"><code>AccessibleObject.setAccessible(boolean)</code></a> are quietly ignored.</div> <dl> @@ -524,7 +525,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>setAccessible</h4> -<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.158">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.159">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Constructor.html?is-external=true"; title="class or interface in java.lang.reflect">Constructor</a><?> x)</pre> <div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -540,7 +541,7 @@ not permitted.)</div> <ul class="blockList"> <li class="blockList"> <h4>setAccessible</h4> -<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.174">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.175">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Method.html?is-external=true"; title="class or interface in java.lang.reflect">Method</a> x)</pre> <div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -556,7 +557,7 @@ not permitted.)</div> <ul class="blockListLast"> <li class="blockList"> <h4>setAccessible</h4> -<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.190">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> +<pre>public static boolean <a href="../../../src-html/org/apache/juneau/Visibility.html#line.191">setAccessible</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/reflect/Field.html?is-external=true"; title="class or interface in java.lang.reflect">Field</a> x)</pre> <div class="block">Attempts to call <code>x.setAccessible(<jk>true</jk>)</code> and quietly ignores security exceptions.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/Bean.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/Bean.html b/content/site/apidocs/org/apache/juneau/annotation/Bean.html index 36bc262..92e1305 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Bean.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Bean.html @@ -131,7 +131,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <th class="colLast" scope="col">Optional Element and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Bean.html#excludeProperties--">excludeProperties</a></span></code> <div class="block">Specifies a list of properties that should be excluded from <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a>.</div> </td> @@ -143,7 +143,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea </td> </tr> <tr class="altColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Bean.html#properties--">properties</a></span></code> <div class="block">The set and order of names of properties associated with a bean class.</div> </td> @@ -205,7 +205,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>typeName</h4> -<pre>public abstract <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/annotation/Bean.html#line.97">typeName</a></pre> +<pre>public abstract <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/annotation/Bean.html#line.95">typeName</a></pre> <div class="block">An identifying name for this class. <p> The name is used to identify the class type during parsing when it cannot be inferred through reflection. @@ -217,10 +217,9 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea a simple name/value mapping of names to classes. Names do not need to be universally unique. However, they must be unique within a dictionary. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + + <h6 class='topic'>Example:</h6> + <p class='bcode'> <ja>@Bean</ja>(typeName=<js>"foo"</js>) <jk>public class</jk> Foo { <jc>// A bean property where the object types cannot be inferred since it's an Object[].</jc> @@ -233,30 +232,29 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ja>@Bean</ja>(typeName=<js>"baz"</js>) <jk>public class</jk> Baz {} - </p> - <p> - When serialized as XML, the bean is rendered as: - </p> - <p class='bcode'> + </p> + <p> + When serialized as XML, the bean is rendered as: + </p> + <p class='bcode'> <xt><foo></xt> <xt><x></xt> <xt><bar/>v <xt><baz/></xt> <xt></x></xt> <xt></foo></xt> - </p> - <p> - When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing: - </p> - <p class='bcode'> + </p> + <p> + When serialized as JSON, <js>'n'</js> attributes would be added when needed to infer the type during parsing: + </p> + <p class='bcode'> { <jsa>x</jsa>: [ {<jsa>_type</jsa>:<jss>'bar'</jss>}, {<jsa>_type</jsa>:<jss>'baz'</jss>} ] } * - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -272,28 +270,25 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <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/annotation/Bean.html#line.119">properties</a></pre> +<pre>public abstract <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/annotation/Bean.html#line.114">properties</a></pre> <div class="block">The set and order of names of properties associated with a bean class. <p> The order specified is the same order that the entries will be returned by the <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a> and related methods. <p> This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanFilter.html" title="class in org.apache.juneau.transform"><code>BeanFilter</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanFilter.html#getProperties--"><code>BeanFilter.getProperties()</code></a> method. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jc>// Address class with only street/city/state properties (in that order).</jc> <jc>// All other properties are ignored.</jc> - <ja>@Bean</ja>(properties={<js>"street"</js>,<js>"city"</js>,<js>"state"</js>}) + <ja>@Bean</ja>(properties=<js>"street,city,state"</js>) <jk>public class</jk> Address { ... - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> @@ -306,7 +301,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>sort</h4> -<pre>public abstract boolean <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.137">sort</a></pre> +<pre>public abstract boolean <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.132">sort</a></pre> <div class="block">Sort bean properties in alphabetical order. <p> When <jk>true</jk>, all bean properties will be serialized and access in alphabetical order. @@ -336,26 +331,22 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>excludeProperties</h4> -<pre>public abstract <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/annotation/Bean.html#line.157">excludeProperties</a></pre> +<pre>public abstract <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/annotation/Bean.html#line.148">excludeProperties</a></pre> <div class="block">Specifies a list of properties that should be excluded from <a href="../../../../org/apache/juneau/BeanMap.html#entrySet--"><code>BeanMap.entrySet()</code></a>. <p> This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanFilter.html" title="class in org.apache.juneau.transform"><code>BeanFilter</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanFilter.html#getExcludeProperties--"><code>BeanFilter.getExcludeProperties()</code></a> method. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jc>// Address class with only street/city/state properties (in that order).</jc> <jc>// All other properties are ignored.</jc> - <ja>@Bean</ja>(excludeProperties={<js>"city"</js>,<js>"state"</js>}) + <ja>@Bean</ja>(excludeProperties=<js>"city,state"</js>}) <jk>public class</jk> Address { ... - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> @@ -368,7 +359,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>propertyNamer</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.181">propertyNamer</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><? extends <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau">PropertyNamer</a>> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.168">propertyNamer</a></pre> <div class="block">Associates a <a href="../../../../org/apache/juneau/PropertyNamer.html" title="interface in org.apache.juneau"><code>PropertyNamer</code></a> with this bean to tailor the names of the bean properties. <p> Property namers are used to transform bean property names from standard form to some other form. @@ -377,18 +368,14 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <p> This annotation is an alternative to using the <a href="../../../../org/apache/juneau/transform/BeanFilter.html" title="class in org.apache.juneau.transform"><code>BeanFilter</code></a> class with an implemented <a href="../../../../org/apache/juneau/transform/BeanFilter.html#getPropertyNamer--"><code>BeanFilter.getPropertyNamer()</code></a> method. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jc>// Define a class with dashed-lowercase property names.</jc> <ja>@Bean</ja>(propertyNamer=PropertyNamerDashedLC.<jk>class</jk>) <jk>public class</jk> MyClass { ... } - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> <dd>org.apache.juneau.PropertyNamerDefault.class</dd> @@ -404,7 +391,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>subTypeProperty</h4> -<pre>public abstract <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/annotation/Bean.html#line.229">subTypeProperty</a></pre> +<pre>public abstract <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/annotation/Bean.html#line.216">subTypeProperty</a></pre> <div class="block">Defines a virtual property on a superclass that identifies bean subtype classes. <p> In the following example, the abstract class has two subclasses that are differentiated @@ -464,7 +451,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>subTypes</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.234">subTypes</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.221">subTypes</a></pre> <div class="block">Used in conjunction with <a href="../../../../org/apache/juneau/annotation/Bean.html#subTypeProperty--"><code>subTypeProperty()</code></a> to set up bean subtypes.</div> <dl> <dt>Default:</dt> @@ -481,7 +468,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>interfaceClass</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.264">interfaceClass</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.251">interfaceClass</a></pre> <div class="block">Identifies a class to be used as the interface class for this and all subclasses. <p> When specified, only the list of properties defined on the interface class will be used during serialization. @@ -523,7 +510,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockListLast"> <li class="blockList"> <h4>stopClass</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.289">stopClass</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.276">stopClass</a></pre> <div class="block">Identifies a stop class for the annotated class. <p> Identical in purpose to the stop class specified by <a href="http://docs.oracle.com/javase/7/docs/api/java/beans/Introspector.html?is-external=true#getBeanInfo-java.lang.Class-java.lang.Class-"; title="class or interface in java.beans"><code>Introspector.getBeanInfo(Class, Class)</code></a>. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html b/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html index 2e53937..f1536c5 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html +++ b/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html @@ -111,7 +111,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <jk>private final</jk> String <jf>name</jf>; <jk>private final int</jk> <jf>age</jf>; - <ja>@BeanConstructor</ja>(properties={<js>"name"</js>,<js>"age"</js>}) + <ja>@BeanConstructor</ja>(properties=<js>"name,age"</js>}) <jk>public</jk> Person(String name, <jk>int</jk> age) { <jk>this</jk>.<jf>name</jf> = name; <jk>this</jk>.<jf>age</jf> = age; @@ -169,7 +169,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <th class="colLast" scope="col">Optional Element and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanConstructor.html#properties--">properties</a></span></code> <div class="block">The names of the properties of the constructor arguments.</div> </td> @@ -195,13 +195,13 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockListLast"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <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/annotation/BeanConstructor.html#line.85">properties</a></pre> +<pre>public abstract <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/annotation/BeanConstructor.html#line.85">properties</a></pre> <div class="block">The names of the properties of the constructor arguments. <p> The number of properties listed must match the number of arguments in the constructor.</div> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html b/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html index 532b440..1988079 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html +++ b/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html @@ -157,7 +157,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#properties--">properties</a></span></code> <div class="block">Used to limit which child properties are rendered by the serializers.</div> </td> @@ -220,7 +220,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>type</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.87">type</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.84">type</a></pre> <div class="block">Identifies a specialized class type for the property. <p> Normally this can be inferred through reflection of the field type or getter return type. @@ -230,19 +230,16 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <p> This property must denote a concrete bean class with a no-arg constructor. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jk>public class</jk> MyBean { <jc>// Identify concrete map type.</jc> <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>) <jk>public</jk> Map <jf>p1</jf>; } - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> <dd>java.lang.Object.class</dd> @@ -258,24 +255,20 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>params</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.108">params</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.101">params</a></pre> <div class="block">For bean properties of maps and collections, this annotation can be used to identify the class types of the contents of the bean property object when the generic parameter types are interfaces or abstract classes. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jk>public class</jk> MyBean { <jc>// Identify concrete map type with String keys and Integer values.</jc> <ja>@BeanProperty</ja>(type=HashMap.<jk>class</jk>, params={String.<jk>class</jk>,Integer.<jk>class</jk>}) <jk>public</jk> Map <jf>p1</jf>; } - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> <dd>{}</dd> @@ -291,7 +284,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>swap</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.134">swap</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?> <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.123">swap</a></pre> <div class="block">Associates a <a href="../../../../org/apache/juneau/transform/PojoSwap.html" title="class in org.apache.juneau.transform"><code>PojoSwap</code></a> or <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a> with this bean property that will swap the value object with another object during serialization and parsing. <p> @@ -301,19 +294,15 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea Typically used for rendering <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true"; title="class or interface in java.util"><code>Dates</code></a> and <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html?is-external=true"; title="class or interface in java.util"><code>Calendars</code></a> as a particular string format. - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jk>public class</jk> MyClass { <jc>// During serialization, convert to ISO8601 date-time string.</jc> <ja>@BeanProperty</ja>(pojoSwap=CalendarSwap.ISO8601DT.<jk>class</jk>) <jk>public</jk> Calendar getTime(); } - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> <dd>org.apache.juneau.internal.Null.class</dd> @@ -329,7 +318,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>properties</h4> -<pre>public abstract <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/annotation/BeanProperty.html#line.169">properties</a></pre> +<pre>public abstract <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/annotation/BeanProperty.html#line.155">properties</a></pre> <div class="block">Used to limit which child properties are rendered by the serializers. <p> Can be used on any of the following bean property types: @@ -340,14 +329,13 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <li>Bean/Map collections - Same, but applied to each element in the collection. </ul> - <dl> - <dt>Example:</dt> - <dd> - <p class='bcode'> + + <h6 class='topic'>Example:</h6> + <p class='bcode'> <jk>public class</jk> MyClass { <jc>// Only render 'f1' when serializing this bean property.</jc> - <ja>@BeanProperty</ja>(properties={<js>"f1"</js>}) + <ja>@BeanProperty</ja>(properties=<js>"f1"</js>) <jk>public</jk> MyChildClass x1 = <jk>new</jk> MyChildClass(); } @@ -358,12 +346,10 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <jc>// Renders "{x1:{f1:1}}"</jc> String json = JsonSerializer.<jsf>DEFAULT</jsf>.serialize(<jk>new</jk> MyClass()); - </p> - </dd> - </dl></div> + </p></div> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> @@ -376,7 +362,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockListLast"> <li class="blockList"> <h4>beanDictionary</h4> -<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.184">beanDictionary</a></pre> +<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true"; title="class or interface in java.lang">Class</a><?>[] <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.170">beanDictionary</a></pre> <div class="block">The list of classes that make up the bean dictionary for this bean property. <p> The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred through reflection. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/Consumes.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/Consumes.html b/content/site/apidocs/org/apache/juneau/annotation/Consumes.html index f691fdd..9227031 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Consumes.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Consumes.html @@ -111,11 +111,11 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con be overridden by subclasses to return the media types programmatically. - <h6 class='topic'>Examples</h6> + <h6 class='topic'>Example:</h6> <p> Standard example: <p class='bcode'> - <ja>@Consumes</ja>({<js>"application/json"</js>,<js>"text/json"</js>}) + <ja>@Consumes</ja>(<js>"application/json,text/json"</js>) <jk>public class</jk> JsonParser <jk>extends</jk> ReaderParser {...} </p> <p> @@ -123,11 +123,11 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'>RFC2616/14.1</a>. <p class='bcode'> <jc>// Consumes any text</jc> - <ja>@Consumes</ja>({<js>"text\/*"</js>}) + <ja>@Consumes</ja>(<js>"text\/*"</js>) <jk>public class</jk> AnythingParser <jk>extends</jk> ReaderParser {...} <jc>// Consumes anything</jc> - <ja>@Consumes</ja>({<js>"*\/*"</js>}) + <ja>@Consumes</ja>(<js>"*\/*"</js>) <jk>public class</jk> AnythingParser <jk>extends</jk> ReaderParser {...} </p></div> <dl> @@ -153,9 +153,9 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con <th class="colLast" scope="col">Optional Element and Description</th> </tr> <tr class="altColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Consumes.html#value--">value</a></span></code> -<div class="block">The media types that the parser can handle.</div> +<div class="block">A comma-delimited list of media types that the parser can handle.</div> </td> </tr> </table> @@ -179,8 +179,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con <ul class="blockListLast"> <li class="blockList"> <h4>value</h4> -<pre>public abstract <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/annotation/Consumes.html#line.72">value</a></pre> -<div class="block">The media types that the parser can handle. +<pre>public abstract <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/annotation/Consumes.html#line.72">value</a></pre> +<div class="block">A comma-delimited list of media types that the parser can handle. <p> Can contain meta-characters per the <code>media-type</code> specification of <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'>RFC2616/14.1</a></div> @@ -190,7 +190,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con </dl> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/Pojo.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/Pojo.html b/content/site/apidocs/org/apache/juneau/annotation/Pojo.html index 6cf4bff..7a6c296 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Pojo.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Pojo.html @@ -158,7 +158,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Poj <li>Any other class. Will get interpreted as a <a href="../../../../org/apache/juneau/transform/SurrogateSwap.html" title="class in org.apache.juneau.transform"><code>SurrogateSwap</code></a>. </ul> - <h6 class='topic'>Example</h6> + <h6 class='topic'>Example:</h6> <p> In this case, a swap is being applied to a bean that will force it to be serialized as a <code>String</code> <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/Produces.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/Produces.html b/content/site/apidocs/org/apache/juneau/annotation/Produces.html index 8bfa03a..77091ad 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Produces.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Produces.html @@ -111,11 +111,11 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro be overridden by subclasses to return the media types programmatically. - <h6 class='topic'>Examples</h6> + <h6 class='topic'>Example:</h6> <p> Standard example: <p class='bcode'> - <ja>@Produces</ja>({<js>"application/json"</js>,<js>"text/json"</js>}) + <ja>@Produces</ja>(<js>"application/json,text/json"</js>) <jk>public class</jk> JsonSerializer <jk>extends</jk> WriterSerializer {...} </p> <p> @@ -162,9 +162,9 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro </td> </tr> <tr class="rowColor"> -<td class="colFirst"><code><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>[]</code></td> +<td class="colFirst"><code><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></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/Produces.html#value--">value</a></span></code> -<div class="block">The media types that the serializer can handle.</div> +<div class="block">A comma-delimited list of the media types that the serializer can handle.</div> </td> </tr> </table> @@ -188,8 +188,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro <ul class="blockList"> <li class="blockList"> <h4>value</h4> -<pre>public abstract <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/annotation/Produces.html#line.75">value</a></pre> -<div class="block">The media types that the serializer can handle. +<pre>public abstract <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/annotation/Produces.html#line.75">value</a></pre> +<div class="block">A comma-delimited list of the media types that the serializer can handle. <p> Can contain meta-characters per the <code>media-type</code> specification of <a href='http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1'>RFC2616/14.1</a></div> @@ -199,7 +199,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro </dl> <dl> <dt>Default:</dt> -<dd>{}</dd> +<dd>""</dd> </dl> </li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/URI.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/URI.html b/content/site/apidocs/org/apache/juneau/annotation/URI.html index 8285c96..ade0a0e 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/URI.html +++ b/content/site/apidocs/org/apache/juneau/annotation/URI.html @@ -111,7 +111,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/URI <p> This annotation can be applied to classes, interfaces, or bean property methods for fields. - <h6 class='topic'>Examples</h6> + <h6 class='topic'>Example:</h6> <p class='bcode'> <jc>// Applied to a class whose toString() method returns a URI.</jc> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/class-use/Bean.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/class-use/Bean.html b/content/site/apidocs/org/apache/juneau/annotation/class-use/Bean.html index 17608f4..6cb4d17 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/class-use/Bean.html +++ b/content/site/apidocs/org/apache/juneau/annotation/class-use/Bean.html @@ -107,18 +107,24 @@ </td> </tr> <tr class="altColor"> +<td class="colFirst"><a href="#org.apache.juneau.dto.swagger">org.apache.juneau.dto.swagger</a></td> +<td class="colLast"> +<div class="block">Swagger Data Transfer Objects</div> +</td> +</tr> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.server.labels">org.apache.juneau.server.labels</a></td> <td class="colLast"> <div class="block">Various REST interface label classes</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.transform">org.apache.juneau.transform</a></td> <td class="colLast"> <div class="block">Transform API</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.xml">org.apache.juneau.xml</a></td> <td class="colLast"> <div class="block">XML serialization and parsing support</div> @@ -264,12 +270,12 @@ </tbody> </table> </li> -<li class="blockList"><a name="org.apache.juneau.server.labels"> +<li class="blockList"><a name="org.apache.juneau.dto.swagger"> <!-- --> </a> -<h3>Uses of <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a> in <a href="../../../../../org/apache/juneau/server/labels/package-summary.html">org.apache.juneau.server.labels</a></h3> +<h3>Uses of <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a> in <a href="../../../../../org/apache/juneau/dto/swagger/package-summary.html">org.apache.juneau.dto.swagger</a></h3> <table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> -<caption><span>Classes in <a href="../../../../../org/apache/juneau/server/labels/package-summary.html">org.apache.juneau.server.labels</a> with annotations of type <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a></span><span class="tabEnd"> </span></caption> +<caption><span>Classes in <a href="../../../../../org/apache/juneau/dto/swagger/package-summary.html">org.apache.juneau.dto.swagger</a> with annotations of type <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a></span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> @@ -277,38 +283,112 @@ <tbody> <tr class="altColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/BeanDescription.html" title="class in org.apache.juneau.server.labels">BeanDescription</a></span></code> -<div class="block">Simple serializable bean description.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Contact.html" title="class in org.apache.juneau.dto.swagger">Contact</a></span></code> +<div class="block">Contact information for the exposed API.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/MethodDescription.html" title="class in org.apache.juneau.server.labels">MethodDescription</a></span></code> -<div class="block">Simple bean for describing REST methods.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ExternalDocumentation.html" title="class in org.apache.juneau.dto.swagger">ExternalDocumentation</a></span></code> +<div class="block">Allows referencing an external resource for extended documentation.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/NameDescription.html" title="class in org.apache.juneau.server.labels">NameDescription</a></span></code> -<div class="block">Simple bean with <code>name</code> and <code>description</code> properties.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/HeaderInfo.html" title="class in org.apache.juneau.dto.swagger">HeaderInfo</a></span></code> +<div class="block">Describes a single HTTP header.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/ParamDescription.html" title="class in org.apache.juneau.server.labels">ParamDescription</a></span></code> -<div class="block">Simple bean for describing GET parameters.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Info.html" title="class in org.apache.juneau.dto.swagger">Info</a></span></code> +<div class="block">The object provides metadata about the API.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/ResourceOptions.html" title="class in org.apache.juneau.server.labels">ResourceOptions</a></span></code> -<div class="block">Default POJO bean used for generating OPTIONS page results.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Items.html" title="class in org.apache.juneau.dto.swagger">Items</a></span></code> +<div class="block">A limited subset of JSON-Schema's items object.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>class </code></td> -<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/Var.html" title="class in org.apache.juneau.server.labels">Var</a></span></code> -<div class="block">A request or response variable.</div> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/License.html" title="class in org.apache.juneau.dto.swagger">License</a></span></code> +<div class="block">License information for the exposed API.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Operation.html" title="class in org.apache.juneau.dto.swagger">Operation</a></span></code> +<div class="block">Describes a single API operation on a path.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ParameterInfo.html" title="class in org.apache.juneau.dto.swagger">ParameterInfo</a></span></code> +<div class="block">Describes a single operation parameter.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/ResponseInfo.html" title="class in org.apache.juneau.dto.swagger">ResponseInfo</a></span></code> +<div class="block">Describes a single response from an API Operation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/SchemaInfo.html" title="class in org.apache.juneau.dto.swagger">SchemaInfo</a></span></code> +<div class="block">The Schema Object allows the definition of input and output data types.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/SecurityScheme.html" title="class in org.apache.juneau.dto.swagger">SecurityScheme</a></span></code> +<div class="block">Allows the definition of a security scheme that can be used by the operations.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Swagger.html" title="class in org.apache.juneau.dto.swagger">Swagger</a></span></code> +<div class="block">This is the root document object for the API specification.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Tag.html" title="class in org.apache.juneau.dto.swagger">Tag</a></span></code> +<div class="block">Allows adding meta data to a single tag that is used by the <a href=../../../../../org/apache/juneau/dto/swagger/'http://swagger.io/specification/#operationObject'>Operation Object</a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/dto/swagger/Xml.html" title="class in org.apache.juneau.dto.swagger">Xml</a></span></code> +<div class="block">A metadata object that allows for more fine-tuned XML model definitions.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"><a name="org.apache.juneau.server.labels"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a> in <a href="../../../../../org/apache/juneau/server/labels/package-summary.html">org.apache.juneau.server.labels</a></h3> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../../org/apache/juneau/server/labels/package-summary.html">org.apache.juneau.server.labels</a> with annotations of type <a href="../../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation">Bean</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/BeanDescription.html" title="class in org.apache.juneau.server.labels">BeanDescription</a></span></code> +<div class="block">Simple serializable bean description.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/juneau/server/labels/NameDescription.html" title="class in org.apache.juneau.server.labels">NameDescription</a></span></code> +<div class="block">Simple bean with <code>name</code> and <code>description</code> properties.</div> </td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/2fd81719/content/site/apidocs/org/apache/juneau/annotation/package-use.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/package-use.html b/content/site/apidocs/org/apache/juneau/annotation/package-use.html index 536001c..37ee75b 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/package-use.html +++ b/content/site/apidocs/org/apache/juneau/annotation/package-use.html @@ -113,84 +113,90 @@ </td> </tr> <tr class="rowColor"> +<td class="colFirst"><a href="#org.apache.juneau.dto.swagger">org.apache.juneau.dto.swagger</a></td> +<td class="colLast"> +<div class="block">Swagger Data Transfer Objects</div> +</td> +</tr> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.html">org.apache.juneau.html</a></td> <td class="colLast"> <div class="block">HTML serialization and parsing support</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.ini">org.apache.juneau.ini</a></td> <td class="colLast"> <div class="block">INI file support</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.jena">org.apache.juneau.jena</a></td> <td class="colLast"> <div class="block">Jena-based RDF serialization and parsing support</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.jso">org.apache.juneau.jso</a></td> <td class="colLast"> <div class="block">Java-serialized-object support</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.json">org.apache.juneau.json</a></td> <td class="colLast"> <div class="block">JSON serialization and parsing support</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.microservice.resources">org.apache.juneau.microservice.resources</a></td> <td class="colLast"> <div class="block">Predefined Microservice Resources</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.msgpack">org.apache.juneau.msgpack</a></td> <td class="colLast"> <div class="block">JSON serialization and parsing support</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.plaintext">org.apache.juneau.plaintext</a></td> <td class="colLast"> <div class="block">Plain-text serialization and parsing support</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.server.labels">org.apache.juneau.server.labels</a></td> <td class="colLast"> <div class="block">Various REST interface label classes</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.soap">org.apache.juneau.soap</a></td> <td class="colLast"> <div class="block">SOAP/XML serialization and parsing support</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.transform">org.apache.juneau.transform</a></td> <td class="colLast"> <div class="block">Transform API</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.urlencoding">org.apache.juneau.urlencoding</a></td> <td class="colLast"> <div class="block">URL encoding serialization and parsing support</div> </td> </tr> -<tr class="rowColor"> +<tr class="altColor"> <td class="colFirst"><a href="#org.apache.juneau.utils">org.apache.juneau.utils</a></td> <td class="colLast"> <div class="block">Utility classes</div> </td> </tr> -<tr class="altColor"> +<tr class="rowColor"> <td class="colFirst"><a href="#org.apache.juneau.xml">org.apache.juneau.xml</a></td> <td class="colLast"> <div class="block">XML serialization and parsing support</div> @@ -314,6 +320,23 @@ </tbody> </table> </li> +<li class="blockList"><a name="org.apache.juneau.dto.swagger"> +<!-- --> +</a> +<table class="useSummary" border="0" cellpadding="3" cellspacing="0" summary="Use table, listing classes, and an explanation"> +<caption><span>Classes in <a href="../../../../org/apache/juneau/annotation/package-summary.html">org.apache.juneau.annotation</a> used by <a href="../../../../org/apache/juneau/dto/swagger/package-summary.html">org.apache.juneau.dto.swagger</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colOne"><a href="../../../../org/apache/juneau/annotation/class-use/Bean.html#org.apache.juneau.dto.swagger">Bean</a> +<div class="block">Used to tailor how beans get interpreted by the framework.</div> +</td> +</tr> +</tbody> +</table> +</li> <li class="blockList"><a name="org.apache.juneau.html"> <!-- --> </a>
