juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [juneau-website] branch asf-site updated: Javadoc update.
Date Mon, 29 Jan 2018 13:40:46 GMT
This is an automated email from the ASF dual-hosted git repository.

jamesbognar pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/juneau-website.git


The following commit(s) were added to refs/heads/asf-site by this push:
     new fdbf2b7  Javadoc update.
fdbf2b7 is described below

commit fdbf2b76f3b80310524a6d9a6b09ccc8f861228a
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Mon Jan 29 08:40:05 2018 -0500

    Javadoc update.
---
 .../org/apache/juneau/annotation/Builder.html      |  5 +-
 content/site/apidocs/overview-summary.html         | 10 ++-
 .../org/apache/juneau/annotation/Builder.html      | 91 +++++++++++-----------
 3 files changed, 55 insertions(+), 51 deletions(-)

diff --git a/content/site/apidocs/org/apache/juneau/annotation/Builder.html b/content/site/apidocs/org/apache/juneau/annotation/Builder.html
index 962d04f..c489b91 100644
--- a/content/site/apidocs/org/apache/juneau/annotation/Builder.html
+++ b/content/site/apidocs/org/apache/juneau/annotation/Builder.html
@@ -96,13 +96,12 @@
  <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.annotat [...]
  <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 j [...]
  <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/Builder.html#line.65">Builder</a></pre>
+public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Builder.html#line.64">Builder</a></pre>
 <div class="block">Identifies a class as a builder for a POJO class.
  
  
  <h6 class='figure'>Example:</h6>
  <p class='bcode'>
-   
    <jc>// POJO class.</jc>
    <ja>@Builder</ja>(MyBeanBuilder.<jk>class</jk>)
    <jk>public class</jk> MyBean {
@@ -181,7 +180,7 @@ public @interface <a href="../../../../src-html/org/apache/juneau/annotation/Bui
 <ul class="blockListLast">
 <li class="blockList">
 <h4>value</h4>
-<pre>public abstract&nbsp;<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>&lt;?&gt;&nbsp;<a
href="../../../../src-html/org/apache/juneau/annotation/Builder.html#line.70">value</a></pre>
+<pre>public abstract&nbsp;<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>&lt;?&gt;&nbsp;<a
href="../../../../src-html/org/apache/juneau/annotation/Builder.html#line.69">value</a></pre>
 <div class="block">The builder for this class.</div>
 <dl>
 <dt>Default:</dt>
diff --git a/content/site/apidocs/overview-summary.html b/content/site/apidocs/overview-summary.html
index 25df898..125591d 100644
--- a/content/site/apidocs/overview-summary.html
+++ b/content/site/apidocs/overview-summary.html
@@ -2771,8 +2771,9 @@
    }
             </p>
             <p>
-               Builders MUST be beans with one or more writable properties.
-               <br>The bean properties themselves do not need to be readable (e.g.
setters without getters).
+               The POJO class can be any type including beans.
+               <br>Builders MUST be beans with one or more writable properties.
+               <br>The bean properties themselves do not need to be readable (i.e.
getters are optional).
             </p>
             <p>
                Builders require two parts:
@@ -2814,6 +2815,11 @@
    <jk>public</jk> MyPojo(MyBuilder b) {...}
                   </p>
             </ul>
+            <h6 class='section'>See Also:</h6>
+            <ul>
+               <li class='ja'><a href="org/apache/juneau/annotation/Builder.html"
title="annotation in org.apache.juneau.annotation"><code>Builder</code></a>
+               <li class='jic'><a href="org/apache/juneau/transform/Builder.html"
title="interface in org.apache.juneau.transform"><code>Builder</code></a>
+            </ul>
          </div>
          
          <!-- ===================================================================================================
-->
diff --git a/content/site/apidocs/src-html/org/apache/juneau/annotation/Builder.html b/content/site/apidocs/src-html/org/apache/juneau/annotation/Builder.html
index 6f8b557..8a95322 100644
--- a/content/site/apidocs/src-html/org/apache/juneau/annotation/Builder.html
+++ b/content/site/apidocs/src-html/org/apache/juneau/annotation/Builder.html
@@ -31,52 +31,51 @@
 <span class="sourceLineNo">023</span> * <a name="line.23"></a>
 <span class="sourceLineNo">024</span> * &lt;h6 class='figure'&gt;Example:&lt;/h6&gt;<a
name="line.24"></a>
 <span class="sourceLineNo">025</span> * &lt;p class='bcode'&gt;<a
name="line.25"></a>
-<span class="sourceLineNo">026</span> *    <a name="line.26"></a>
-<span class="sourceLineNo">027</span> *    &lt;jc&gt;// POJO class.&lt;/jc&gt;<a
name="line.27"></a>
-<span class="sourceLineNo">028</span> *    &lt;ja&gt;@Builder&lt;/ja&gt;(MyBeanBuilder.&lt;jk&gt;class&lt;/jk&gt;)<a
name="line.28"></a>
-<span class="sourceLineNo">029</span> *    &lt;jk&gt;public class&lt;/jk&gt;
MyBean {<a name="line.29"></a>
-<span class="sourceLineNo">030</span> * <a name="line.30"></a>
-<span class="sourceLineNo">031</span> *       &lt;jc&gt;// Read-only
properties.&lt;/jc&gt;<a name="line.31"></a>
-<span class="sourceLineNo">032</span> *       &lt;jk&gt;public final&lt;/jk&gt;
String &lt;jf&gt;foo&lt;/jf&gt;;<a name="line.32"></a>
-<span class="sourceLineNo">033</span> *       &lt;jk&gt;public final
int&lt;/jk&gt; &lt;jf&gt;bar&lt;/jf&gt;;<a name="line.33"></a>
-<span class="sourceLineNo">034</span> * <a name="line.34"></a>
-<span class="sourceLineNo">035</span> *       &lt;jc&gt;// Constructor
that takes in a builder.&lt;/jc&gt;<a name="line.35"></a>
-<span class="sourceLineNo">036</span> *       &lt;jk&gt;public&lt;/jk&gt;
MyBean(MyBeanBuilder b) {<a name="line.36"></a>
-<span class="sourceLineNo">037</span> *          &lt;jk&gt;this&lt;/jk&gt;.&lt;jf&gt;foo&lt;/jf&gt;
= b.foo;<a name="line.37"></a>
-<span class="sourceLineNo">038</span> *          &lt;jk&gt;this&lt;/jk&gt;.&lt;jf&gt;bar&lt;/jf&gt;
= b.bar;<a name="line.38"></a>
-<span class="sourceLineNo">039</span> *       }<a name="line.39"></a>
-<span class="sourceLineNo">040</span> *    }<a name="line.40"></a>
-<span class="sourceLineNo">041</span> *    <a name="line.41"></a>
-<span class="sourceLineNo">042</span> *    &lt;jc&gt;// Builder class.&lt;/jc&gt;<a
name="line.42"></a>
-<span class="sourceLineNo">043</span> *    &lt;jk&gt;public class&lt;/jk&gt;
MyBeanBuilder {<a name="line.43"></a>
-<span class="sourceLineNo">044</span> *       &lt;jk&gt;public&lt;/jk&gt;
String &lt;jf&gt;foo&lt;/jf&gt;;<a name="line.44"></a>
-<span class="sourceLineNo">045</span> *       &lt;jk&gt;public int&lt;/jk&gt;
&lt;jf&gt;bar&lt;/jf&gt;;<a name="line.45"></a>
-<span class="sourceLineNo">046</span> *          <a name="line.46"></a>
-<span class="sourceLineNo">047</span> *       &lt;jc&gt;// Method that
creates the bean.&lt;/jc&gt;<a name="line.47"></a>
-<span class="sourceLineNo">048</span> *       &lt;jk&gt;public&lt;/jk&gt;
MyBean build() {<a name="line.48"></a>
-<span class="sourceLineNo">049</span> *          &lt;jk&gt;return new&lt;/jk&gt;
MyBean(&lt;jk&gt;this&lt;/jk&gt;);<a name="line.49"></a>
-<span class="sourceLineNo">050</span> *       }<a name="line.50"></a>
-<span class="sourceLineNo">051</span> *       <a name="line.51"></a>
-<span class="sourceLineNo">052</span> *       &lt;jc&gt;// Bean property
setters.&lt;/jc&gt;<a name="line.52"></a>
-<span class="sourceLineNo">053</span> *    }<a name="line.53"></a>
-<span class="sourceLineNo">054</span> * &lt;/p&gt;<a name="line.54"></a>
-<span class="sourceLineNo">055</span> * <a name="line.55"></a>
-<span class="sourceLineNo">056</span> * &lt;h5 class='topic'&gt;Documentation&lt;/h5&gt;<a
name="line.56"></a>
-<span class="sourceLineNo">057</span> * &lt;ul&gt;<a name="line.57"></a>
-<span class="sourceLineNo">058</span> *    &lt;li&gt;&lt;a class="doclink"
href="../../../../overview-summary.html#juneau-marshall.PojoBuilders"&gt;Overview &amp;gt;
POJO Builders&lt;/a&gt;<a name="line.58"></a>
-<span class="sourceLineNo">059</span> * &lt;/ul&gt;<a name="line.59"></a>
-<span class="sourceLineNo">060</span> */<a name="line.60"></a>
-<span class="sourceLineNo">061</span>@Documented<a name="line.61"></a>
-<span class="sourceLineNo">062</span>@Target({TYPE})<a name="line.62"></a>
-<span class="sourceLineNo">063</span>@Retention(RUNTIME)<a name="line.63"></a>
-<span class="sourceLineNo">064</span>@Inherited<a name="line.64"></a>
-<span class="sourceLineNo">065</span>public @interface Builder {<a name="line.65"></a>
-<span class="sourceLineNo">066</span><a name="line.66"></a>
-<span class="sourceLineNo">067</span>   /**<a name="line.67"></a>
-<span class="sourceLineNo">068</span>    * The builder for this class.<a name="line.68"></a>
-<span class="sourceLineNo">069</span>    */<a name="line.69"></a>
-<span class="sourceLineNo">070</span>   Class&lt;?&gt; value() default
Null.class;<a name="line.70"></a>
-<span class="sourceLineNo">071</span>}<a name="line.71"></a>
+<span class="sourceLineNo">026</span> *    &lt;jc&gt;// POJO class.&lt;/jc&gt;<a
name="line.26"></a>
+<span class="sourceLineNo">027</span> *    &lt;ja&gt;@Builder&lt;/ja&gt;(MyBeanBuilder.&lt;jk&gt;class&lt;/jk&gt;)<a
name="line.27"></a>
+<span class="sourceLineNo">028</span> *    &lt;jk&gt;public class&lt;/jk&gt;
MyBean {<a name="line.28"></a>
+<span class="sourceLineNo">029</span> * <a name="line.29"></a>
+<span class="sourceLineNo">030</span> *       &lt;jc&gt;// Read-only
properties.&lt;/jc&gt;<a name="line.30"></a>
+<span class="sourceLineNo">031</span> *       &lt;jk&gt;public final&lt;/jk&gt;
String &lt;jf&gt;foo&lt;/jf&gt;;<a name="line.31"></a>
+<span class="sourceLineNo">032</span> *       &lt;jk&gt;public final
int&lt;/jk&gt; &lt;jf&gt;bar&lt;/jf&gt;;<a name="line.32"></a>
+<span class="sourceLineNo">033</span> * <a name="line.33"></a>
+<span class="sourceLineNo">034</span> *       &lt;jc&gt;// Constructor
that takes in a builder.&lt;/jc&gt;<a name="line.34"></a>
+<span class="sourceLineNo">035</span> *       &lt;jk&gt;public&lt;/jk&gt;
MyBean(MyBeanBuilder b) {<a name="line.35"></a>
+<span class="sourceLineNo">036</span> *          &lt;jk&gt;this&lt;/jk&gt;.&lt;jf&gt;foo&lt;/jf&gt;
= b.foo;<a name="line.36"></a>
+<span class="sourceLineNo">037</span> *          &lt;jk&gt;this&lt;/jk&gt;.&lt;jf&gt;bar&lt;/jf&gt;
= b.bar;<a name="line.37"></a>
+<span class="sourceLineNo">038</span> *       }<a name="line.38"></a>
+<span class="sourceLineNo">039</span> *    }<a name="line.39"></a>
+<span class="sourceLineNo">040</span> *    <a name="line.40"></a>
+<span class="sourceLineNo">041</span> *    &lt;jc&gt;// Builder class.&lt;/jc&gt;<a
name="line.41"></a>
+<span class="sourceLineNo">042</span> *    &lt;jk&gt;public class&lt;/jk&gt;
MyBeanBuilder {<a name="line.42"></a>
+<span class="sourceLineNo">043</span> *       &lt;jk&gt;public&lt;/jk&gt;
String &lt;jf&gt;foo&lt;/jf&gt;;<a name="line.43"></a>
+<span class="sourceLineNo">044</span> *       &lt;jk&gt;public int&lt;/jk&gt;
&lt;jf&gt;bar&lt;/jf&gt;;<a name="line.44"></a>
+<span class="sourceLineNo">045</span> *          <a name="line.45"></a>
+<span class="sourceLineNo">046</span> *       &lt;jc&gt;// Method that
creates the bean.&lt;/jc&gt;<a name="line.46"></a>
+<span class="sourceLineNo">047</span> *       &lt;jk&gt;public&lt;/jk&gt;
MyBean build() {<a name="line.47"></a>
+<span class="sourceLineNo">048</span> *          &lt;jk&gt;return new&lt;/jk&gt;
MyBean(&lt;jk&gt;this&lt;/jk&gt;);<a name="line.48"></a>
+<span class="sourceLineNo">049</span> *       }<a name="line.49"></a>
+<span class="sourceLineNo">050</span> *       <a name="line.50"></a>
+<span class="sourceLineNo">051</span> *       &lt;jc&gt;// Bean property
setters.&lt;/jc&gt;<a name="line.51"></a>
+<span class="sourceLineNo">052</span> *    }<a name="line.52"></a>
+<span class="sourceLineNo">053</span> * &lt;/p&gt;<a name="line.53"></a>
+<span class="sourceLineNo">054</span> * <a name="line.54"></a>
+<span class="sourceLineNo">055</span> * &lt;h5 class='topic'&gt;Documentation&lt;/h5&gt;<a
name="line.55"></a>
+<span class="sourceLineNo">056</span> * &lt;ul&gt;<a name="line.56"></a>
+<span class="sourceLineNo">057</span> *    &lt;li&gt;&lt;a class="doclink"
href="../../../../overview-summary.html#juneau-marshall.PojoBuilders"&gt;Overview &amp;gt;
POJO Builders&lt;/a&gt;<a name="line.57"></a>
+<span class="sourceLineNo">058</span> * &lt;/ul&gt;<a name="line.58"></a>
+<span class="sourceLineNo">059</span> */<a name="line.59"></a>
+<span class="sourceLineNo">060</span>@Documented<a name="line.60"></a>
+<span class="sourceLineNo">061</span>@Target({TYPE})<a name="line.61"></a>
+<span class="sourceLineNo">062</span>@Retention(RUNTIME)<a name="line.62"></a>
+<span class="sourceLineNo">063</span>@Inherited<a name="line.63"></a>
+<span class="sourceLineNo">064</span>public @interface Builder {<a name="line.64"></a>
+<span class="sourceLineNo">065</span><a name="line.65"></a>
+<span class="sourceLineNo">066</span>   /**<a name="line.66"></a>
+<span class="sourceLineNo">067</span>    * The builder for this class.<a name="line.67"></a>
+<span class="sourceLineNo">068</span>    */<a name="line.68"></a>
+<span class="sourceLineNo">069</span>   Class&lt;?&gt; value() default
Null.class;<a name="line.69"></a>
+<span class="sourceLineNo">070</span>}<a name="line.70"></a>
 
 
 

-- 
To stop receiving notification emails like this one, please contact
jamesbognar@apache.org.

Mime
View raw message