http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/UriResolver.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/UriResolver.html b/content/site/apidocs/org/apache/juneau/UriResolver.html index 590b6db..15000a4 100644 --- a/content/site/apidocs/org/apache/juneau/UriResolver.html +++ b/content/site/apidocs/org/apache/juneau/UriResolver.html @@ -108,7 +108,7 @@ var activeTableTab = "activeTableTab"; <li class="blockList"> <hr> <br> -<pre>public class <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.50">UriResolver</a> +<pre>public class <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.51">UriResolver</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">Class used to create absolute and root-relative URIs based on your current URI 'location' and rules about how to make such resolutions. @@ -117,7 +117,8 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? (<a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau"><code>UriRelativity</code></a>) to define simple <a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-"><code>resolve(Object)</code></a> and <a href="../../../org/apache/juneau/UriResolver.html#append-java.lang.Appendable-java.lang.Object-"><code>append(Appendable, Object)</code></a> methods. <p> - Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative URIs: + Three special protocols are used to represent context-root-relative, servlet-relative, and request-path-relative + URIs: <js>"context:/"</js>, <js>"servlet:/"</js>, and <js>"request:/"</js>. The following list shows the protocols of URLs that can be resolved with this class: @@ -221,7 +222,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>UriResolver</h4> -<pre>public <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.63">UriResolver</a>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, +<pre>public <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.64">UriResolver</a>(<a href="../../../org/apache/juneau/UriResolution.html" title="enum in org.apache.juneau">UriResolution</a> resolution, <a href="../../../org/apache/juneau/UriRelativity.html" title="enum in org.apache.juneau">UriRelativity</a> relativity, <a href="../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau">UriContext</a> uriContext)</pre> <div class="block">Constructor.</div> @@ -247,7 +248,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>resolve</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/UriResolver.html#line.99">resolve</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> +<pre>public <a href="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/UriResolver.html#line.100">resolve</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> <div class="block">Converts the specified URI to absolute form based on values in this context.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> @@ -283,7 +284,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockList"> <li class="blockList"> <h4>relativize</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/UriResolver.html#line.130">relativize</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> relativeTo, +<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/UriResolver.html#line.131">relativize</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> relativeTo, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> uri)</pre> <div class="block">Relativizes a URI. <p> @@ -310,7 +311,7 @@ extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html? <ul class="blockListLast"> <li class="blockList"> <h4>append</h4> -<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.143">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> a, +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> <a href="../../../src-html/org/apache/juneau/UriResolver.html#line.144">append</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true"; title="class or interface in java.lang">Appendable</a> 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> o)</pre> <div class="block">Same as <a href="../../../org/apache/juneau/UriResolver.html#resolve-java.lang.Object-"><code>resolve(Object)</code></a> except appends result to the specified appendable.</div> <dl>
http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 488d2a0..a4ad573 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Bean.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Bean.html @@ -209,8 +209,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea output so that the class can be determined during parsing. It is also used to specify element names in XML. <p> - The name is used in combination with the bean dictionary defined through <a href="../../../../org/apache/juneau/annotation/BeanProperty.html#beanDictionary--"><code>BeanProperty.beanDictionary()</code></a> or <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanDictionary"><code>BeanContext.BEAN_beanDictionary</code></a>. Together, they make up - a simple name/value mapping of names to classes. + The name is used in combination with the bean dictionary defined through <a href="../../../../org/apache/juneau/annotation/BeanProperty.html#beanDictionary--"><code>BeanProperty.beanDictionary()</code></a> or + <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanDictionary"><code>BeanContext.BEAN_beanDictionary</code></a>. Together, they make up 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. <h5 class='section'>Example:</h5> @@ -265,7 +265,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>typePropertyName</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.128">typePropertyName</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.129">typePropertyName</a></pre> <div class="block">The property name to use for representing the type name. <p> This can be used to override the name used for the <js>"_type"</js> property designated above. @@ -296,7 +296,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea common HTML attribute names. </ul> - The default value if not specified is <js>"_type"</js> unless overridden by the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanTypePropertyName"><code>BeanContext.BEAN_beanTypePropertyName</code></a> setting.</div> + The default value if not specified is <js>"_type"</js> unless overridden by the + <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanTypePropertyName"><code>BeanContext.BEAN_beanTypePropertyName</code></a> setting.</div> <dl> <dt>Default:</dt> <dd>""</dd> @@ -312,12 +313,14 @@ 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.146">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.149">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. + 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. + 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. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -342,14 +345,14 @@ 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.164">sort</a></pre> +<pre>public abstract boolean <a href="../../../../src-html/org/apache/juneau/annotation/Bean.html#line.167">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. Otherwise, the natural order of the bean properties is used which is dependent on the JVM vendor. On IBM JVMs, the bean properties are ordered based on their ordering in the Java file. - On Oracle JVMs, the bean properties are not ordered (which follows the offical JVM specs). + On Oracle JVMs, the bean properties are not ordered (which follows the official JVM specs). <p> This property is disabled by default so that IBM JVM users don't have to use <a href="../../../../org/apache/juneau/annotation/Bean.html" title="annotation in org.apache.juneau.annotation"><code>@Bean</code></a> annotations to force bean properties to be in a particular order and can just alter the order of the fields/methods @@ -372,10 +375,11 @@ 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.180">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.184">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. + 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. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -400,14 +404,15 @@ 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.200">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.205">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. - For example, the <a href="../../../../org/apache/juneau/PropertyNamerDLC.html" title="class in org.apache.juneau"><code>PropertyNamerDLC</code></a> will convert property names to dashed-lowercase, and - these will be used as attribute names in JSON, and element names in XML. + For example, the <a href="../../../../org/apache/juneau/PropertyNamerDLC.html" title="class in org.apache.juneau"><code>PropertyNamerDLC</code></a> will convert property names to dashed-lowercase, and these will be used + as attribute names in JSON, and element names in XML. <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. + 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. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -432,7 +437,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.230">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.236">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. @@ -458,7 +463,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea Note that this annotation can be used on the parent class so that it filters to all child classes, or can be set individually on the child classes. <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#getInterfaceClass--"><code>BeanFilter.getInterfaceClass()</code></a> method.</div> + 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#getInterfaceClass--"><code>BeanFilter.getInterfaceClass()</code></a> method.</div> <dl> <dt>Default:</dt> <dd>java.lang.Object.class</dd> @@ -474,14 +480,14 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <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.255">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.261">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>. - Any properties in the stop class or in its baseclasses will be ignored during analysis. + Any properties in the stop class or in its base classes will be ignored during analysis. <p> - For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, but - not <code>p1</code> or <code>p2</code>. + For example, in the following class hierarchy, instances of <code>C3</code> will include property <code>p3</code>, + but not <code>p1</code> or <code>p2</code>. <p class='bcode'> <jk>public class</jk> C1 { <jk>public int</jk> getP1(); @@ -511,7 +517,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/Bean.html#line.273">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/Bean.html#line.279">beanDictionary</a></pre> <div class="block">The list of classes that make up the bean dictionary for all properties of this bean or for subclasses of this bean. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 61ef947..746da3c 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html +++ b/content/site/apidocs/org/apache/juneau/annotation/BeanConstructor.html @@ -96,13 +96,14 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#CONSTRUCTOR"; title="class or interface in java.lang.annotation">CONSTRUCTOR</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanConstructor.html#line.76">BeanConstructor</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanConstructor.html#line.77">BeanConstructor</a></pre> <div class="block">Maps constructor arguments to property names on beans with read-only properties. <p> - This annotation can be used in the case of beans with properties whose values can only be set by passing - them in through a constructor on the class.<br> - Since method parameter names are lost during compilation, this annotation essentially redefines them - so that they are available at runtime. + This annotation can be used in the case of beans with properties whose values can only be set by passing them in + through a constructor on the class. + <br> + Since method parameter names are lost during compilation, this annotation essentially redefines them so that they + are available at runtime. <p> The definition of a read-only bean is a bean with properties with only getters, like shown below... <p class='bcode'> @@ -190,7 +191,7 @@ 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.83">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.84">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> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/annotation/BeanIgnore.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/BeanIgnore.html b/content/site/apidocs/org/apache/juneau/annotation/BeanIgnore.html index 4c91bda..d8d7a3e 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/BeanIgnore.html +++ b/content/site/apidocs/org/apache/juneau/annotation/BeanIgnore.html @@ -100,8 +100,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <div class="block">Ignore classes, fields, and methods from being interpreted as bean or bean components. <p> Applied to classes that may look like beans, but you want to be treated as non-beans. - For example, if you want to force a bean to be converted to a string using the <code>toString()</code> - method, use this annoation on the class. + For example, if you want to force a bean to be converted to a string using the <code>toString()</code> method, use + this annotation on the class. <p> Applies to fields that should not be interpreted as bean property fields. <p> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 794b8db..0b744a2 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html +++ b/content/site/apidocs/org/apache/juneau/annotation/BeanProperty.html @@ -96,7 +96,7 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>}) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.46">BeanProperty</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/BeanProperty.html#line.48">BeanProperty</a></pre> <div class="block">Used tailor how bean properties get interpreted by the framework. <p> Can be used to do the following: @@ -106,8 +106,10 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <li>Identify a specific subclass for a property with a general class type. <li>Identify class types of elements in properties of type <code>Collection</code> or <code>Map</code>. <li>Hide properties during serialization. - <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field to a string. - <li>Override the list of properties during serialization on child elements of a property of type <code>Collection</code> or <code>Map</code>. + <li>Associate transforms with bean property values, such as a POJO swap to convert a <code>Calendar</code> field + to a string. + <li>Override the list of properties during serialization on child elements of a property of type + <code>Collection</code> or <code>Map</code>. <li>Identify a property as the URL for a bean. <li>Identify a property as the ID for a bean. </ul> @@ -152,9 +154,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <tr class="rowColor"> <td class="colFirst"><code><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><?>[]</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#params--">params</a></span></code> -<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.</div> +<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.</div> </td> </tr> <tr class="altColor"> @@ -167,7 +168,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <td class="colFirst"><code><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><?></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/juneau/annotation/BeanProperty.html#swap--">swap</a></span></code> <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.</div> + with another object during serialization and parsing.</div> </td> </tr> <tr class="altColor"> @@ -203,20 +204,23 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <li class="blockList"> <h4>name</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.129">name</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.135">name</a></pre> <div class="block">Identifies the name of the property. <p> Normally, this is automatically inferred from the field name or getter method name - of the property. However, this property can be used to assign a different - property name from the automatically inferred value. + of the property. However, this property can be used to assign a different + property name from the automatically inferred value. <p> - If the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanFieldVisibility"><code>BeanContext.BEAN_beanFieldVisibility</code></a> setting on the bean context excludes this field (e.g. the visibility - is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be identified as a property. + If the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_beanFieldVisibility"><code>BeanContext.BEAN_beanFieldVisibility</code></a> setting on the bean context excludes this field (e.g. the + visibility is set to PUBLIC, but the field is PROTECTED), this annotation can be used to force the field to be + identified as a property. <p> <h6 class='topic'>Dynamic beans</h6> - The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean properties not otherwise defined. + The bean property named <js>"*"</js> is the designated "dynamic property" which allows for "extra" bean + properties not otherwise defined. This is similar in concept to the Jackson <ja>@JsonGetterAll</ja> and <ja>@JsonSetterAll</ja> annotations. - The primary purpose is for backwards compatibility in parsing newer streams with addition information into older beans. + The primary purpose is for backwards compatibility in parsing newer streams with addition information into older + beans. <p> The following examples show how to define dynamic bean properties. <p class='bcode'> @@ -256,8 +260,8 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea } </p> <p> - Similar rules apply for value types and swaps. The property values optionally can be any serializable type - or use swaps. + Similar rules apply for value types and swaps. The property values optionally can be any serializable type or + use swaps. <p class='bcode'> <jc>// A serializable type other than Object.</jc> <jk>public class</jk> BeanWithDynaFieldWithListValues { @@ -280,8 +284,9 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <p> <ul class='doctree'> <li class='info'> - Note that if you're not interested in these additional properties, you can also use the <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_ignoreUnknownBeanProperties"><code>BeanContext.BEAN_ignoreUnknownBeanProperties</code></a> setting - to ignore values that don't fit into existing properties. + Note that if you're not interested in these additional properties, you can also use the + <a href="../../../../org/apache/juneau/BeanContext.html#BEAN_ignoreUnknownBeanProperties"><code>BeanContext.BEAN_ignoreUnknownBeanProperties</code></a> setting to ignore values that don't fit into existing + properties. </ul></div> <dl> <dt>Default:</dt> @@ -298,7 +303,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <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/BeanProperty.html#line.142">value</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.148">value</a></pre> <div class="block">A synonym for <a href="../../../../org/apache/juneau/annotation/BeanProperty.html#name--"><code>name()</code></a>. <p> The following annotations are equivalent: @@ -323,13 +328,13 @@ 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.164">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.170">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. - However, you'll want to specify this value if you're parsing beans where the bean property class - is an interface or abstract class to identify the bean type to instantiate. Otherwise, you may - cause an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InstantiationException.html?is-external=true"; title="class or interface in java.lang"><code>InstantiationException</code></a> when trying to set these fields. + However, you'll want to specify this value if you're parsing beans where the bean property class is an interface + or abstract class to identify the bean type to instantiate. + Otherwise, you may cause an <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/InstantiationException.html?is-external=true"; title="class or interface in java.lang"><code>InstantiationException</code></a> when trying to set these fields. <p> This property must denote a concrete bean class with a no-arg constructor. @@ -357,10 +362,9 @@ 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.181">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. +<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.186">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. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -386,15 +390,13 @@ 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.203">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.206">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. + with another object during serialization and parsing. <p> - This annotation supersedes any swaps associated with the bean property type - class itself. + This annotation supersedes any swaps associated with the bean property type class itself. <p> - 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. + 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. <h5 class='section'>Example:</h5> <p class='bcode'> @@ -420,7 +422,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.234">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.237">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: @@ -463,10 +465,11 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockList"> <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.251">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.255">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. + The dictionary is a name/class mapping used to find class types during parsing when they cannot be inferred + through reflection. The names are defined through the <a href="../../../../org/apache/juneau/annotation/Bean.html#typeName--"><code>Bean.typeName()</code></a> annotation defined on the bean class. <p> This list can consist of the following class types: @@ -492,13 +495,13 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bea <ul class="blockListLast"> <li class="blockList"> <h4>format</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.267">format</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.271">format</a></pre> <div class="block">Specifies a String format for converting the bean property value to a formatted string. <p> Note that this is usually a one-way conversion during serialization. <p> - During parsing, we will attempt to convert the value to the original form by using the <a href="../../../../org/apache/juneau/BeanSession.html#convertToType-java.lang.Object-java.lang.Class-"><code>BeanSession.convertToType(Object, Class)</code></a> - but there is no guarantee that this will succeed. + During parsing, we will attempt to convert the value to the original form by using the + <a href="../../../../org/apache/juneau/BeanSession.html#convertToType-java.lang.Object-java.lang.Class-"><code>BeanSession.convertToType(Object, Class)</code></a> but there is no guarantee that this will succeed. <h5 class='section'>Example:</h5> <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 21605bd..c1ac6ce 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Consumes.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Consumes.html @@ -96,17 +96,16 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE"; title="class or interface in java.lang.annotation">TYPE</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Consumes.html#line.58">Consumes</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Consumes.html#line.57">Consumes</a></pre> <div class="block">Annotation used on subclasses of <a href="../../../../org/apache/juneau/parser/Parser.html" title="class in org.apache.juneau.parser"><code>Parser</code></a> to identify the media types that it consumes. <h5 class='section'>Description:</h5> <p> Provides a way to define the contents of <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> through an annotation. <p> - The <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> default implementation gathers the media types by looking - for this annotation. - It should be noted that this annotation is optional and that the <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> method can - be overridden by subclasses to return the media types programmatically. + The <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> default implementation gathers the media types by looking for this annotation. + It should be noted that this annotation is optional and that the <a href="../../../../org/apache/juneau/parser/Parser.html#getMediaTypes--"><code>Parser.getMediaTypes()</code></a> method can be + overridden by subclasses to return the media types programmatically. <h5 class='section'>Example:</h5> <p> @@ -176,7 +175,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Con <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 class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a></div> + <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The media types that the parser can handle.</dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/annotation/NameProperty.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/NameProperty.html b/content/site/apidocs/org/apache/juneau/annotation/NameProperty.html index f418e2f..042d964 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/NameProperty.html +++ b/content/site/apidocs/org/apache/juneau/annotation/NameProperty.html @@ -95,7 +95,7 @@ <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>}) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/NameProperty.html#line.54">NameProperty</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/NameProperty.html#line.56">NameProperty</a></pre> <div class="block">Identifies a setter as a method for setting the name of a POJO as it's known by its parent object. <p> @@ -103,8 +103,10 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Nam <a href="../../../../org/apache/juneau/ini/ConfigFileImpl.html" title="class in org.apache.juneau.ini"><code>ConfigFileImpl</code></a> class, so parsers will call this method with the section name using the <a href="../../../../org/apache/juneau/ini/Section.html#setName-java.lang.String-"><code>Section.setName(String)</code></a> method. <p> - A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties - is the key used in the map. For example: + A commonly-used case is when you're parsing a JSON map containing beans where one of the bean properties is the key + used in the map. + <br> + For example: <p class='bcode'> { id1: {name: <js>'John Smith'</js>, sex:<js>'M'</js>}, http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/annotation/ParentProperty.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/annotation/ParentProperty.html b/content/site/apidocs/org/apache/juneau/annotation/ParentProperty.html index fb886f2..c2e1661 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/ParentProperty.html +++ b/content/site/apidocs/org/apache/juneau/annotation/ParentProperty.html @@ -95,13 +95,12 @@ <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD"; title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD"; title="class or interface in java.lang.annotation">FIELD</a>}) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/ParentProperty.html#line.51">ParentProperty</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/ParentProperty.html#line.50">ParentProperty</a></pre> <div class="block">Identifies a setter as a method for adding a parent reference to a child object. <p> Used by the parsers to add references to parent objects in child objects. - For example, the <a href="../../../../org/apache/juneau/ini/Section.html" title="class in org.apache.juneau.ini"><code>Section</code></a> class cannot exist outside the scope of a parent - <a href="../../../../org/apache/juneau/ini/ConfigFileImpl.html" title="class in org.apache.juneau.ini"><code>ConfigFileImpl</code></a> class, so parsers will add a reference to the config file - using the <a href="../../../../org/apache/juneau/ini/Section.html#setParent-org.apache.juneau.ini.ConfigFileImpl-"><code>Section.setParent(ConfigFileImpl)</code></a> method. + For example, the <a href="../../../../org/apache/juneau/ini/Section.html" title="class in org.apache.juneau.ini"><code>Section</code></a> class cannot exist outside the scope of a parent <a href="../../../../org/apache/juneau/ini/ConfigFileImpl.html" title="class in org.apache.juneau.ini"><code>ConfigFileImpl</code></a> class, so + parsers will add a reference to the config file using the <a href="../../../../org/apache/juneau/ini/Section.html#setParent-org.apache.juneau.ini.ConfigFileImpl-"><code>Section.setParent(ConfigFileImpl)</code></a> method. <p> A commonly-used case is when you're parsing beans, and a child bean has a reference to a parent bean. <p class='bcode'> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 da14e94..b86a484 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Pojo.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Pojo.html @@ -155,7 +155,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Poj <h5 class='section'>Example:</h5> <p> - In this case, a swap is being applied to a bean that will force it to be serialized as a <code>String</code> + 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'> <jc>// Our bean class</jc> <ja>@Pojo</ja>(swap=BSwap.<jk>class</jk>) http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 a3a9aa1..3f0344d 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/Produces.html +++ b/content/site/apidocs/org/apache/juneau/annotation/Produces.html @@ -96,17 +96,17 @@ <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true"; title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Target.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE"; title="class or interface in java.lang.annotation">TYPE</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true"; title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Retention.html?is-external=true#value--"; title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME"; title="class or interface in java.lang.annotation">RUNTIME</a>) <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/annotation/Inherited.html?is-external=true"; title="class or interface in java.lang.annotation">@Inherited</a> -public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Produces.html#line.61">Produces</a></pre> +public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Produces.html#line.62">Produces</a></pre> <div class="block">Annotation used on subclasses of <a href="../../../../org/apache/juneau/serializer/Serializer.html" title="class in org.apache.juneau.serializer"><code>Serializer</code></a> to identify the media types that it produces. <h5 class='section'>Description:</h5> <p> Provides a way to define the contents of <a href="../../../../org/apache/juneau/serializer/Serializer.html#getMediaTypes--"><code>Serializer.getMediaTypes()</code></a> through an annotation. <p> - The <a href="../../../../org/apache/juneau/serializer/Serializer.html#getMediaTypes--"><code>Serializer.getMediaTypes()</code></a> default implementation gathers the media types by looking - for this annotation. + The <a href="../../../../org/apache/juneau/serializer/Serializer.html#getMediaTypes--"><code>Serializer.getMediaTypes()</code></a> default implementation gathers the media types by looking for this annotation. + <br> It should be noted that this annotation is optional and that the <a href="../../../../org/apache/juneau/serializer/Serializer.html#getMediaTypes--"><code>Serializer.getMediaTypes()</code></a> method can - be overridden by subclasses to return the media types programmatically. + be overridden by subclasses to return the media types programmatically. <h5 class='section'>Example:</h5> <p> @@ -117,9 +117,10 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro </p> <p> The media types can also be <code>media-range</code> values per - <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a>. - When meta-characters are used, you should specify the <a href="../../../../org/apache/juneau/annotation/Produces.html#contentType--"><code>contentType()</code></a> value to - indicate the real media type value that can be set on the <code>Content-Type</code> response header. + <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a>. + <br> + When meta-characters are used, you should specify the <a href="../../../../org/apache/juneau/annotation/Produces.html#contentType--"><code>contentType()</code></a> value to indicate the real media type + value that can be set on the <code>Content-Type</code> response header. <p class='bcode'> <jc>// Produces any text</jc> @@ -181,11 +182,11 @@ 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.70">value</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/Produces.html#line.72">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 class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a></div> + <a class="doclink" href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1";>RFC2616/14.1</a></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The media types that the parser can handle.</dd> @@ -205,12 +206,11 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Pro <ul class="blockListLast"> <li class="blockList"> <h4>contentType</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.80">contentType</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/Produces.html#line.82">contentType</a></pre> <div class="block">The content type that this serializer produces. <p> - Can be used to override the <code>Content-Type</code> response type if the media types - are <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code> - differs from the media type for some reason.</div> + Can be used to override the <code>Content-Type</code> response type if the media types are + <code>media-ranges</code> with meta-characters, or the <code>Content-Type</code> differs from the media type for some reason.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>The content type that this serializer produces, or blank if no overriding value exists.</dd> http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/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 9df0d20..7ce40b2 100644 --- a/content/site/apidocs/org/apache/juneau/annotation/URI.html +++ b/content/site/apidocs/org/apache/juneau/annotation/URI.html @@ -99,19 +99,19 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/URI.html#line.72">URI</a></pre> <div class="block">Used to identify a class or bean property as a URI. <p> - By default, instances of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="../../../../org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>URI</code></a> are considered URIs during serialization, and are - handled differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink, - <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...). + By default, instances of <a href="http://docs.oracle.com/javase/7/docs/api/java/net/URL.html?is-external=true"; title="class or interface in java.net"><code>URL</code></a> and <a href="../../../../org/apache/juneau/annotation/URI.html" title="annotation in org.apache.juneau.annotation"><code>URI</code></a> are considered URIs during serialization, and are handled + differently depending on the serializer (e.g. <code>HtmlSerializer</code> creates a hyperlink, + <code>RdfXmlSerializer</code> creates an <code>rdf:resource</code> object, etc...). <p> This annotation allows you to identify other classes that return URIs via <code>toString()</code> as URI objects. <p> URIs are automatically resolved to absolute or root-relative form based on the serializer - <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriResolution"><code>SerializerContext.SERIALIZER_uriResolution</code></a> and <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriRelativity"><code>SerializerContext.SERIALIZER_uriRelativity</code></a> - configuration settings, and the URI context defined by the <a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau"><code>UriContext</code></a> that's part of the serializer - session. + <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriResolution"><code>SerializerContext.SERIALIZER_uriResolution</code></a> and <a href="../../../../org/apache/juneau/serializer/SerializerContext.html#SERIALIZER_uriRelativity"><code>SerializerContext.SERIALIZER_uriRelativity</code></a> + configuration settings, and the URI context defined by the <a href="../../../../org/apache/juneau/UriContext.html" title="class in org.apache.juneau"><code>UriContext</code></a> that's part of the serializer + session. <p> Refer to the <a href="../../../../org/apache/juneau/UriResolver.html" title="class in org.apache.juneau"><code>UriResolver</code></a> class for information about the types of URIs that can be resolved during - serialization. + serialization. <p> This annotation can be applied to classes, interfaces, or bean property methods for fields. http://git-wip-us.apache.org/repos/asf/incubator-juneau-website/blob/89e089cf/content/site/apidocs/org/apache/juneau/csv/CsvParser.html ---------------------------------------------------------------------- diff --git a/content/site/apidocs/org/apache/juneau/csv/CsvParser.html b/content/site/apidocs/org/apache/juneau/csv/CsvParser.html index 404394d..b26b648 100644 --- a/content/site/apidocs/org/apache/juneau/csv/CsvParser.html +++ b/content/site/apidocs/org/apache/juneau/csv/CsvParser.html @@ -273,7 +273,7 @@ extends <a href="../../../../org/apache/juneau/parser/ReaderParser.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>CsvParser</h4> -<pre>public <a href="../../../../src-html/org/apache/juneau/csv/CsvParser.html#line.33">CsvParser</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/csv/CsvParser.html#line.34">CsvParser</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> @@ -295,7 +295,7 @@ extends <a href="../../../../org/apache/juneau/parser/ReaderParser.html" title=" <ul class="blockList"> <li class="blockList"> <h4>builder</h4> -<pre>public <a href="../../../../org/apache/juneau/csv/CsvParserBuilder.html" title="class in org.apache.juneau.csv">CsvParserBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParser.html#line.38">builder</a>()</pre> +<pre>public <a href="../../../../org/apache/juneau/csv/CsvParserBuilder.html" title="class in org.apache.juneau.csv">CsvParserBuilder</a> <a href="../../../../src-html/org/apache/juneau/csv/CsvParser.html#line.39">builder</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/CoreObject.html#builder--">CoreObject</a></code></span></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> @@ -313,7 +313,7 @@ extends <a href="../../../../org/apache/juneau/parser/ReaderParser.html" title=" <ul class="blockListLast"> <li class="blockList"> <h4>doParse</h4> -<pre>protected <T> T <a href="../../../../src-html/org/apache/juneau/csv/CsvParser.html#line.52">doParse</a>(<a href="../../../../org/apache/juneau/parser/ParserSession.html" title="class in org.apache.juneau.parser">ParserSession</a> session, +<pre>protected <T> T <a href="../../../../src-html/org/apache/juneau/csv/CsvParser.html#line.53">doParse</a>(<a href="../../../../org/apache/juneau/parser/ParserSession.html" title="class in org.apache.juneau.parser">ParserSession</a> session, <a href="../../../../org/apache/juneau/ClassMeta.html" title="class in org.apache.juneau">ClassMeta</a><T> type) throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> <div class="block"><span class="descfrmTypeLabel">Description copied from class: <code><a href="../../../../org/apache/juneau/parser/Parser.html#doParse-org.apache.juneau.parser.ParserSession-org.apache.juneau.ClassMeta-">Parser</a></code></span></div> @@ -324,11 +324,13 @@ extends <a href="../../../../org/apache/juneau/parser/ReaderParser.html" title=" <dt><span class="paramLabel">Type Parameters:</span></dt> <dd><code>T</code> - The class type of the object to create.</dd> <dt><span class="paramLabel">Parameters:</span></dt> -<dd><code>session</code> - The runtime session object returned by <a href="../../../../org/apache/juneau/parser/Parser.html#createSession-java.lang.Object-org.apache.juneau.ObjectMap-java.lang.reflect.Method-java.lang.Object-java.util.Locale-java.util.TimeZone-org.apache.juneau.http.MediaType-"><code>Parser.createSession(Object, ObjectMap, Method, Object, Locale, TimeZone, MediaType)</code></a>. +<dd><code>session</code> - The runtime session object returned by <a href="../../../../org/apache/juneau/parser/Parser.html#createSession-java.lang.Object-org.apache.juneau.ObjectMap-java.lang.reflect.Method-java.lang.Object-java.util.Locale-java.util.TimeZone-org.apache.juneau.http.MediaType-"><code>Parser.createSession(Object, ObjectMap, Method, Object, + Locale, TimeZone, MediaType)</code></a>. If <jk>null</jk>, one will be created using <a href="../../../../org/apache/juneau/parser/Parser.html#createSession-java.lang.Object-"><code>Parser.createSession(Object)</code></a>.</dd> <dd><code>type</code> - The class type of the object to create. If <jk>null</jk> or <code>Object.<jk>class</jk></code>, object type is based on what's being parsed. - For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>, <code>ObjectMap</code>, etc...</dd> + For example, when parsing JSON text, it may return a <code>String</code>, <code>Number</code>, + <code>ObjectMap</code>, etc...</dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>The parsed object.</dd> <dt><span class="throwsLabel">Throws:</span></dt>
