http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/ClassMetaExtended.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/ClassMetaExtended.html b/content/site/apidocs/org/apache/juneau/ClassMetaExtended.html index 9951212..741c447 100644 --- a/content/site/apidocs/org/apache/juneau/ClassMetaExtended.html +++ b/content/site/apidocs/org/apache/juneau/ClassMetaExtended.html @@ -112,12 +112,13 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public class <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.21">ClassMetaExtended</a> +<pre>public class <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.22">ClassMetaExtended</a> 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></pre> <div class="block">Defines extended language-specific metadata associated with a class. + <p> - Serializers and parsers can implement their own language-specific metadata on a class and retrieve - the metadata using the <a href="../../../org/apache/juneau/ClassMeta.html#getExtendedMeta-java.lang.Class-"><code>ClassMeta.getExtendedMeta(Class)</code></a> method.</div> + Serializers and parsers can implement their own language-specific metadata on a class and retrieve the metadata + using the <a href="../../../org/apache/juneau/ClassMeta.html#getExtendedMeta-java.lang.Class-"><code>ClassMeta.getExtendedMeta(Class)</code></a> method.</div> </li> </ul> </div> @@ -195,7 +196,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>ClassMetaExtended</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.30">ClassMetaExtended</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm) +<pre>public <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.32">ClassMetaExtended</a>(<a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> cm) throws <a href="../../../org/apache/juneau/BeanRuntimeException.html" title="class in org.apache.juneau">BeanRuntimeException</a></pre> <div class="block">Constructor.</div> <dl> @@ -220,7 +221,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getClassMeta</h4> -<pre>protected <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.38">getClassMeta</a>()</pre> +<pre>protected <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><?> <a href="../../../src-html/org/apache/juneau/ClassMetaExtended.html#line.41">getClassMeta</a>()</pre> <div class="block">Returns the class metadata that was passed into the constructor.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -234,7 +235,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>getInnerClass</h4> -<pre>protected <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/ClassMetaExtended.html#line.46">getInnerClass</a>()</pre> +<pre>protected <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/ClassMetaExtended.html#line.50">getInnerClass</a>()</pre> <div class="block">Convenience method for calling <a href="../../../org/apache/juneau/ClassMeta.html#getInnerClass--"><code>ClassMeta.getInnerClass()</code></a> on the metadata passed to the constructor.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/1b5bde65/content/site/apidocs/org/apache/juneau/Context.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/Context.html b/content/site/apidocs/org/apache/juneau/Context.html index 227a95e..5239d12 100644 --- a/content/site/apidocs/org/apache/juneau/Context.html +++ b/content/site/apidocs/org/apache/juneau/Context.html @@ -112,16 +112,18 @@ var activeTableTab = "activeTableTab"; </dl> <hr> <br> -<pre>public abstract class <a href="../../../src-html/org/apache/juneau/Context.html#line.32">Context</a> +<pre>public abstract class <a href="../../../src-html/org/apache/juneau/Context.html#line.34">Context</a> 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></pre> <div class="block">A reusable stateless thread-safe read-only configuration, typically used for creating one-time use <a href="../../../org/apache/juneau/Session.html" title="class in org.apache.juneau"><code>Session</code></a> objects. + <p> Contexts are created through the <a href="../../../org/apache/juneau/PropertyStore.html#getContext-java.lang.Class-"><code>PropertyStore.getContext(Class)</code></a> method. + <p> Subclasses MUST implement a constructor method that takes in a <a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau"><code>PropertyStore</code></a> parameter. - Besides that restriction, a context object can do anything you desire. However, it MUST - be thread-safe and all fields should be declared final to prevent modification. + Besides that restriction, a context object can do anything you desire. + However, it MUST be thread-safe and all fields should be declared final to prevent modification. It should NOT be used for storing temporary or state information.</div> <dl> <dt><span class="seeLabel">See Also:</span></dt> @@ -208,8 +210,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>Context</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/Context.html#line.43">Context</a>(<a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre> +<pre>public <a href="../../../src-html/org/apache/juneau/Context.html#line.46">Context</a>(<a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre> <div class="block">Constructor for this class. + <p> Subclasses MUST implement the same constructor.</div> <dl> @@ -232,7 +235,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getPropertyStore</h4> -<pre>protected <a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../src-html/org/apache/juneau/Context.html#line.52">getPropertyStore</a>()</pre> +<pre>protected <a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../src-html/org/apache/juneau/Context.html#line.55">getPropertyStore</a>()</pre> <div class="block">Returns the property store associated with this context.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -247,7 +250,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <li class="blockList"> <h4>asMap</h4> <pre><a href="../../../org/apache/juneau/annotation/Overrideable.html" title="annotation in org.apache.juneau.annotation">@Overrideable</a> -public <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/Context.html#line.62">asMap</a>()</pre> +public <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/Context.html#line.65">asMap</a>()</pre> <div class="block">Returns the properties defined on this bean context as a simple map for debugging purposes.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -261,7 +264,7 @@ public <a href="../../../org/apache/juneau/ObjectMap.html" title="class in <ul class="blockListLast"> <li class="blockList"> <h4>toString</h4> -<pre>public final <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/Context.html#line.67">toString</a>()</pre> +<pre>public final <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/Context.html#line.70">toString</a>()</pre> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--"; title="class or interface in java.lang">toString</a></code> in class <code><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/1b5bde65/content/site/apidocs/org/apache/juneau/CoreObject.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/CoreObject.html b/content/site/apidocs/org/apache/juneau/CoreObject.html index 0b557fd..7163b3e 100644 --- a/content/site/apidocs/org/apache/juneau/CoreObject.html +++ b/content/site/apidocs/org/apache/juneau/CoreObject.html @@ -178,22 +178,21 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <tr id="i0" class="altColor"> <td class="colFirst"><code><a href="../../../org/apache/juneau/CoreObjectBuilder.html" title="class in org.apache.juneau">CoreObjectBuilder</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/CoreObject.html#builder--">builder</a></span>()</code> -<div class="block">Creates a new builder class for this object so that a new object can be created - that expands upon the current object's settings.</div> +<div class="block">Creates a new builder class for this object so that a new object can be created that expands upon the current + object's settings.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code>protected <T extends <a href="../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>><br>T</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/CoreObject.html#createContext-java.lang.Class-">createContext</a></span>(<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> c)</code> -<div class="block">Creates a read-only context object of the specified type using the context - factory on this class.</div> +<div class="block">Creates a read-only context object of the specified type using the context factory on this class.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/CoreObject.html#createPropertyStore--">createPropertyStore</a></span>()</code> -<div class="block">Returns a copy of the context factory passed in to the constructor with - any override properties applied from the <a href="../../../org/apache/juneau/CoreObject.html#getOverrideProperties--"><code>getOverrideProperties()</code></a>.</div> +<div class="block">Returns a copy of the context factory passed in to the constructor with any override properties applied from the + <a href="../../../org/apache/juneau/CoreObject.html#getOverrideProperties--"><code>getOverrideProperties()</code></a>.</div> </td> </tr> <tr id="i3" class="rowColor"> @@ -205,8 +204,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <tr id="i4" class="altColor"> <td class="colFirst"><code>protected <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/juneau/CoreObject.html#getOverrideProperties--">getOverrideProperties</a></span>()</code> -<div class="block">Method used by subclasses to override context factory properties for just this - instance without modifying the context factory itself.</div> +<div class="block">Method used by subclasses to override context factory properties for just this instance without modifying the + context factory itself.</div> </td> </tr> <tr id="i5" class="rowColor"> @@ -267,7 +266,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>CoreObject</h4> -<pre>protected <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.29">CoreObject</a>(<a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre> +<pre>protected <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.30">CoreObject</a>(<a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> propertyStore)</pre> <div class="block">Constructor.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -289,9 +288,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>builder</h4> -<pre>public <a href="../../../org/apache/juneau/CoreObjectBuilder.html" title="class in org.apache.juneau">CoreObjectBuilder</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.40">builder</a>()</pre> -<div class="block">Creates a new builder class for this object so that a new object can be created - that expands upon the current object's settings.</div> +<pre>public <a href="../../../org/apache/juneau/CoreObjectBuilder.html" title="class in org.apache.juneau">CoreObjectBuilder</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.41">builder</a>()</pre> +<div class="block">Creates a new builder class for this object so that a new object can be created that expands upon the current + object's settings.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>A new builder.</dd> @@ -304,12 +303,12 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getOverrideProperties</h4> -<pre>protected <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.53">getOverrideProperties</a>()</pre> -<div class="block">Method used by subclasses to override context factory properties for just this - instance without modifying the context factory itself. +<pre>protected <a href="../../../org/apache/juneau/ObjectMap.html" title="class in org.apache.juneau">ObjectMap</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.54">getOverrideProperties</a>()</pre> +<div class="block">Method used by subclasses to override context factory properties for just this instance without modifying the + context factory itself. + <p> - Subclasses can call this parent method to append to override properties defined - higher in the parent chain.</div> + Subclasses can call this parent method to append to override properties defined higher in the parent chain.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The override properties. Never <jk>null</jk>.</dd> @@ -322,13 +321,13 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createPropertyStore</h4> -<pre>public <a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.64">createPropertyStore</a>()</pre> -<div class="block">Returns a copy of the context factory passed in to the constructor with - any override properties applied from the <a href="../../../org/apache/juneau/CoreObject.html#getOverrideProperties--"><code>getOverrideProperties()</code></a>.</div> +<pre>public <a href="../../../org/apache/juneau/PropertyStore.html" title="class in org.apache.juneau">PropertyStore</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.66">createPropertyStore</a>()</pre> +<div class="block">Returns a copy of the context factory passed in to the constructor with any override properties applied from the + <a href="../../../org/apache/juneau/CoreObject.html#getOverrideProperties--"><code>getOverrideProperties()</code></a>.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The context factory on this class. - Multiple calls to this method returns the same factory.</dd> + Multiple calls to this method returns the same factory.</dd> </dl> </li> </ul> @@ -338,9 +337,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>createContext</h4> -<pre>protected <T extends <a href="../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>> T <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.75">createContext</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> c)</pre> -<div class="block">Creates a read-only context object of the specified type using the context - factory on this class.</div> +<pre>protected <T extends <a href="../../../org/apache/juneau/Context.html" title="class in org.apache.juneau">Context</a>> T <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.76">createContext</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> c)</pre> +<div class="block">Creates a read-only context object of the specified type using the context factory on this class.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>c</code> - The context class to create.</dd> @@ -355,7 +353,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>getBeanContext</h4> -<pre>public <a href="../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.83">getBeanContext</a>()</pre> +<pre>public <a href="../../../org/apache/juneau/BeanContext.html" title="class in org.apache.juneau">BeanContext</a> <a href="../../../src-html/org/apache/juneau/CoreObject.html#line.85">getBeanContext</a>()</pre> <div class="block">Returns the bean context to use for this class.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> @@ -369,9 +367,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>object</h4> -<pre>public <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</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/CoreObject.html#line.97">object</a>()</pre> +<pre>public <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</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/CoreObject.html#line.99">object</a>()</pre> <div class="block">Returns the universal <code>Object</code> metadata object. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>getBeanContext().object();</code>. @@ -388,9 +386,9 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>string</h4> -<pre>public <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</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/CoreObject.html#line.111">string</a>()</pre> +<pre>public <a href="../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</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/CoreObject.html#line.113">string</a>()</pre> <div class="block">Returns the universal <code>String</code> metadata object. - <p> + <h5 class='section'>Notes:</h5> <ul> <li>This is equivalent to calling <code>getBeanContext().string();</code>.
