juneau-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jamesbog...@apache.org
Subject [juneau] branch master updated: Javadocs.
Date Sun, 09 Dec 2018 21:27:02 GMT
This is an automated email from the ASF dual-hosted git repository.

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


The following commit(s) were added to refs/heads/master by this push:
     new fbaaac9  Javadocs.
fbaaac9 is described below

commit fbaaac9881c22a584b1e1e0a7a13f847a69c0e88
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Sun Dec 9 16:26:51 2018 -0500

    Javadocs.
---
 .../java/org/apache/juneau/svl/vars/ArgsVar.java   |  2 +-
 .../docs/Topics/06.juneau-config/09.Listeners.html |  4 +-
 .../28.HtmlDocAnnotation/04.UiCustomization.html   |  2 +-
 .../11.juneau-microservice-core/01.Overview.html   |  4 +-
 .../11.juneau-microservice-core/05.Config.html     |  4 +-
 .../07.VarResolver.html                            |  2 +-
 juneau-doc/src/main/javadoc/overview.html          | 29 +++++-----
 .../juneau/examples/rest/petstore/dto/PetTag.java  | 16 +-----
 .../dto/{PetTag.java => PetTagNameSwap.java}       | 63 ++++------------------
 .../juneau/microservice/MicroserviceBuilder.java   |  4 +-
 10 files changed, 38 insertions(+), 92 deletions(-)

diff --git a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
index 3663d2b..c282c67 100644
--- a/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
+++ b/juneau-core/juneau-svl/src/main/java/org/apache/juneau/svl/vars/ArgsVar.java
@@ -42,7 +42,7 @@ import org.apache.juneau.utils.*;
  * 	VarResolver r = <jk>new</jk> VarResolver().addVars(ArgsVar.<js>class</js>);
  *
  * 	<jc>// Use it!</jc>
- * 	System.<jsf>out</jsf>.println(r.resolve(<js>"Arg #1 is set to $ARGS{1}"</js>));
+ * 	System.<jsf>out</jsf>.println(r.resolve(<js>"Arg #1 is set to $A{1}"</js>));
  * </p>
  *
  * <p>
diff --git a/juneau-doc/docs/Topics/06.juneau-config/09.Listeners.html b/juneau-doc/docs/Topics/06.juneau-config/09.Listeners.html
index 44bf5c5..b4b4f8a 100644
--- a/juneau-doc/docs/Topics/06.juneau-config/09.Listeners.html
+++ b/juneau-doc/docs/Topics/06.juneau-config/09.Listeners.html
@@ -31,7 +31,7 @@ Listeners
 <ul class='doctree'>
 	<li class='jic'>{@link oaj.config.event.ConfigEventListener}
 	<ul>
-		<li class='jm'>{@link oaj.config.event.ConfigEventListener#onConfigChange(List) onConfigChange(List&lt;ConfigEvent&gt;)}
+		<li class='jm'>{@link oaj.config.event.ConfigEventListener#onConfigChange(ConfigEvents)
onConfigChange(ConfigEvents)}
 	</ul>
 </ul>
 <p>
@@ -66,7 +66,7 @@ Listeners
 	c.addListener(
 		<jk>new</jk> ConfigEventListener() {
 			<ja>@Override</ja>
-			<jk>public void</jk> onConfigChange(List&lt;ConfigEvent&gt; events)
{
+			<jk>public void</jk> onConfigChange(ConfigEvents) {
 				<jk>for</jk> (ConfigEvent event : events) {
 					<jk>if</jk> (event.getType() == <jsf>SET_ENTRY</jsf>) {
 						
diff --git a/juneau-doc/docs/Topics/07.juneau-rest-server/28.HtmlDocAnnotation/04.UiCustomization.html
b/juneau-doc/docs/Topics/07.juneau-rest-server/28.HtmlDocAnnotation/04.UiCustomization.html
index 5b2126b..4d094db 100644
--- a/juneau-doc/docs/Topics/07.juneau-rest-server/28.HtmlDocAnnotation/04.UiCustomization.html
+++ b/juneau-doc/docs/Topics/07.juneau-rest-server/28.HtmlDocAnnotation/04.UiCustomization.html
@@ -157,5 +157,5 @@ UI Customization
 </p>
 <h5 class='section'>See Also:</h5>
 <ul>
-	<li class='link'>{@doc juneau-microservice.UiCustomization}
+	<li class='link'>{@doc juneau-microservice-jetty.UiCustomization}
 </ul>
diff --git a/juneau-doc/docs/Topics/11.juneau-microservice-core/01.Overview.html b/juneau-doc/docs/Topics/11.juneau-microservice-core/01.Overview.html
index e01f2f2..d993909 100644
--- a/juneau-doc/docs/Topics/11.juneau-microservice-core/01.Overview.html
+++ b/juneau-doc/docs/Topics/11.juneau-microservice-core/01.Overview.html
@@ -101,12 +101,12 @@
 		<li class='jm'>{@link oaj.microservice.Microservice#log(Level,String,Object...) log(Level,String,Object...)}

 		<li class='jm'>{@link oaj.microservice.Microservice#out(MessageBundle,String,Object...)
out(MessageBundle,String,Object...)} 
 		<li class='jm'>{@link oaj.microservice.Microservice#err(MessageBundle,String,Object...)
err(MessageBundle,String,Object...)} 
-		<li class='jm'>{@link oaj.microservice.Microservice#onConfigChange(List) onConfigChange(List)}

+		<li class='jm'>{@link oaj.microservice.Microservice#onConfigChange(ConfigEvents)
onConfigChange(ConfigEvents)} 
 		<li class='jm'>{@link oaj.microservice.Microservice#executeCommand(Args,Scanner,PrintWriter)
executeCommand(Args,Scanner,PrintWriter)} 
 	</ul>
 	<li class='jic'>{@link oaj.microservice.MicroserviceListener}
 	<ul>
-		<li class='jm'>{@link oaj.microservice.MicroserviceListener#onConfigChange(Microservice,List)
onConfigChange(Microservice,List)} 
+		<li class='jm'>{@link oaj.microservice.MicroserviceListener#onConfigChange(Microservice,ConfigEvents)
onConfigChange(Microservice,ConfigEvents)} 
 		<li class='jm'>{@link oaj.microservice.MicroserviceListener#onStart(Microservice)
onStart(Microservice)} 
 		<li class='jm'>{@link oaj.microservice.MicroserviceListener#onStop(Microservice)
onStop(Microservice)} 
 	</ul>
diff --git a/juneau-doc/docs/Topics/11.juneau-microservice-core/05.Config.html b/juneau-doc/docs/Topics/11.juneau-microservice-core/05.Config.html
index 22a98b1..b4e97a6 100644
--- a/juneau-doc/docs/Topics/11.juneau-microservice-core/05.Config.html
+++ b/juneau-doc/docs/Topics/11.juneau-microservice-core/05.Config.html
@@ -124,8 +124,8 @@
 <p>
 	Changes to the configuration file can trigger notifications that can be used to restart
your microservice or make various other
 	on-the-fly changes.  
-	This can be accomplished by either overriding the {@link oaj.microservice.Microservice#onConfigChange(List)}
or implementing
-	a listener and using the {@link oaj.microservice.MicroserviceListener#onConfigChange(Microservice,List)}
methods.
+	This can be accomplished by either overriding the {@link oaj.microservice.Microservice#onConfigChange(ConfigEvents)}
or implementing
+	a listener and using the {@link oaj.microservice.MicroserviceListener#onConfigChange(Microservice,ConfigEvents)}
methods.
 	These will be described in detail later.
 </p>
 
diff --git a/juneau-doc/docs/Topics/11.juneau-microservice-core/07.VarResolver.html b/juneau-doc/docs/Topics/11.juneau-microservice-core/07.VarResolver.html
index 85ee49d..0687e91 100644
--- a/juneau-doc/docs/Topics/11.juneau-microservice-core/07.VarResolver.html
+++ b/juneau-doc/docs/Topics/11.juneau-microservice-core/07.VarResolver.html
@@ -24,7 +24,7 @@
 <ul class='doctree'>
 	<li class='jc'>{@link oaj.microservice.MicroserviceBuilder}
 	<ul>
-		<li class='jm'>{@link oaj.microservice.MicroserviceBuilder#vars(Class) vars(Class...)}

+		<li class='jm'>{@link oaj.microservice.MicroserviceBuilder#vars(Class...) vars(Class...)}

 		<li class='jm'>{@link oaj.microservice.MicroserviceBuilder#varContext(String, Object)
varContext(String,Object)} 
 	</ul>
 </ul>
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 09a086f..bde6ecc 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -12222,7 +12222,7 @@
 <ul class='doctree'>
 	<li class='jic'>{@link org.apache.juneau.config.event.ConfigEventListener}
 	<ul>
-		<li class='jm'>{@link org.apache.juneau.config.event.ConfigEventListener#onConfigChange(List)
onConfigChange(List&lt;ConfigEvent&gt;)}
+		<li class='jm'>{@link org.apache.juneau.config.event.ConfigEventListener#onConfigChange(ConfigEvents)
onConfigChange(ConfigEvents)}
 	</ul>
 </ul>
 <p>
@@ -12257,7 +12257,7 @@
 	c.addListener(
 		<jk>new</jk> ConfigEventListener() {
 			<ja>@Override</ja>
-			<jk>public void</jk> onConfigChange(List&lt;ConfigEvent&gt; events)
{
+			<jk>public void</jk> onConfigChange(ConfigEvents) {
 				<jk>for</jk> (ConfigEvent event : events) {
 					<jk>if</jk> (event.getType() == <jsf>SET_ENTRY</jsf>) {
 						
@@ -20368,7 +20368,7 @@
 </p>
 <h5 class='section'>See Also:</h5>
 <ul>
-	<li class='link'>{@doc juneau-microservice.UiCustomization}
+	<li class='link'>{@doc juneau-microservice-jetty.UiCustomization}
 </ul>
 </div><!-- END: 7.28.4 - juneau-rest-server.HtmlDocAnnotation.UiCustomization -->
 
@@ -23587,12 +23587,12 @@
 		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#log(Level,String,Object...)
log(Level,String,Object...)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#out(MessageBundle,String,Object...)
out(MessageBundle,String,Object...)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#err(MessageBundle,String,Object...)
err(MessageBundle,String,Object...)} 
-		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#onConfigChange(List)
onConfigChange(List)} 
+		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#onConfigChange(ConfigEvents)
onConfigChange(ConfigEvents)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.Microservice#executeCommand(Args,Scanner,PrintWriter)
executeCommand(Args,Scanner,PrintWriter)} 
 	</ul>
 	<li class='jic'>{@link org.apache.juneau.microservice.MicroserviceListener}
 	<ul>
-		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceListener#onConfigChange(Microservice,List)
onConfigChange(Microservice,List)} 
+		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceListener#onConfigChange(Microservice,ConfigEvents)
onConfigChange(Microservice,ConfigEvents)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceListener#onStart(Microservice)
onStart(Microservice)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceListener#onStop(Microservice)
onStop(Microservice)} 
 	</ul>
@@ -23939,8 +23939,8 @@
 <p>
 	Changes to the configuration file can trigger notifications that can be used to restart
your microservice or make various other
 	on-the-fly changes.  
-	This can be accomplished by either overriding the {@link org.apache.juneau.microservice.Microservice#onConfigChange(List)}
or implementing
-	a listener and using the {@link org.apache.juneau.microservice.MicroserviceListener#onConfigChange(Microservice,List)}
methods.
+	This can be accomplished by either overriding the {@link org.apache.juneau.microservice.Microservice#onConfigChange(ConfigEvents)}
or implementing
+	a listener and using the {@link org.apache.juneau.microservice.MicroserviceListener#onConfigChange(Microservice,ConfigEvents)}
methods.
 	These will be described in detail later.
 </p>
 
@@ -23993,7 +23993,7 @@
 <ul class='doctree'>
 	<li class='jc'>{@link org.apache.juneau.microservice.MicroserviceBuilder}
 	<ul>
-		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceBuilder#vars(Class)
vars(Class...)} 
+		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceBuilder#vars(Class...)
vars(Class...)} 
 		<li class='jm'>{@link org.apache.juneau.microservice.MicroserviceBuilder#varContext(String,
Object) varContext(String,Object)} 
 	</ul>
 </ul>
@@ -25260,14 +25260,19 @@
 <ul class='doctree'>
 	<li class='jp'>{@link org.apache.juneau.examples.core.json}
 	<ul>
-		<li class='jc'>{@link org.apache.juneau.examples.core.json.JsonSimpleExample} - TODO
-		<li class='jc'>{@link org.apache.juneau.examples.core.json.JsonComplexExample} -
TODO
+		<li class='jc'>{@link org.apache.juneau.examples.core.json.JsonSimpleExample} - JsonSerializer
and JsonParser usage on serialize and deserialize simple Pojo bean.
+		<li class='jc'>{@link org.apache.juneau.examples.core.json.JsonComplexExample} -
JsonSerializer and JsonParser usage on serialize and deserialize complex Pojo bean.
 		<li class='jc'>{@link org.apache.juneau.examples.core.json.JsonConfigurationExample}
- TODO
 	</ul>
 	<li class='jp'><code>org.apache.juneau.examples.core.xml</code>
 	<ul>
-		<li class='jc'>{@link org.apache.juneau.examples.core.xml.XmlSimpleExample} - TODO
-		<li class='jc'>{@link org.apache.juneau.examples.core.xml.XmlComplexExample} - TODO
+		<li class='jc'>{@link org.apache.juneau.examples.core.xml.XmlSimpleExample} - XmlSerializer
and XmlParser usage on serialize and deserialize simple Pojo bean.
+		<li class='jc'>{@link org.apache.juneau.examples.core.xml.XmlComplexExample} - XmlSerializer
and XmlParser usage on serialize and deserialize complex Pojo bean.
+	</ul>
+	<li class='jp'><code>org.apache.juneau.examples.core.rdf</code>
+	<ul>
+		<li class='jc'>{@link org.apache.juneau.examples.core.rdf.RdfExample} - RdfXmlSerializer
usage on serialize simple Pojo bean.
+		<li class='jc'>{@link org.apache.juneau.examples.core.rdf.RdfComplexExample} - RdfXmlSerializer
usage on serialize complex Pojo bean.
 	</ul>
 </ul>
 </div><!-- END: 14.1 - juneau-examples-core.Examples -->
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
index f968e74..429def4 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
@@ -14,14 +14,11 @@ package org.apache.juneau.examples.rest.petstore.dto;
 
 import java.util.*;
 
-import org.apache.juneau.*;
 import org.apache.juneau.annotation.*;
-import org.apache.juneau.http.*;
 import org.apache.juneau.internal.*;
-import org.apache.juneau.transform.*;
 
 @Bean(typeName="Tag", fluentSetters=true)
-@Swap(PetTag.TagNameOnly.class)
+@Swap(PetTagNameSwap.class)
 public class PetTag {
 	private long id;
 	private String name;
@@ -51,17 +48,6 @@ public class PetTag {
 			.name("MyTag");
 	}
 
-	public static class TagNameOnly extends PojoSwap<PetTag,String> {
-		@Override
-		public String swap(BeanSession bs, PetTag o) throws Exception {
-			return o.getName();
-		}
-		@Override
-		public MediaType[] forMediaTypes() {
-			return new MediaType[] { MediaType.HTML };
-		}
-	}
-
 	public static String asString(List<PetTag> tags) {
 		if (tags == null)
 			return "";
diff --git a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTagNameSwap.java
similarity index 59%
copy from juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
copy to juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTagNameSwap.java
index f968e74..6bff077 100644
--- a/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTag.java
+++ b/juneau-examples/juneau-examples-rest/src/main/java/org/apache/juneau/examples/rest/petstore/dto/PetTagNameSwap.java
@@ -2,7 +2,7 @@
 // * Licensed to the Apache Software Foundation (ASF) under one or more contributor license
agreements.  See the NOTICE file *
 // * distributed with this work for additional information regarding copyright ownership.
 The ASF licenses this file        *
 // * to you under the Apache License, Version 2.0 (the "License"); you may not use this file
except in compliance            *
-// * with the License.  You may obtain a copy of the License at                         
                                    *
+// * with the License.  You may obtain a copy of the License at                         
                                    * 
 // *                                                                                    
                                    *
 // *  http://www.apache.org/licenses/LICENSE-2.0                                        
                                    *
 // *                                                                                    
                                    *
@@ -12,62 +12,17 @@
 // ***************************************************************************************************************************
 package org.apache.juneau.examples.rest.petstore.dto;
 
-import java.util.*;
-
 import org.apache.juneau.*;
-import org.apache.juneau.annotation.*;
 import org.apache.juneau.http.*;
-import org.apache.juneau.internal.*;
 import org.apache.juneau.transform.*;
 
-@Bean(typeName="Tag", fluentSetters=true)
-@Swap(PetTag.TagNameOnly.class)
-public class PetTag {
-	private long id;
-	private String name;
-
-	public long getId() {
-		return id;
-	}
-
-	public PetTag id(long id) {
-		this.id = id;
-		return this;
+public class PetTagNameSwap extends PojoSwap<PetTag,String> {
+	@Override
+	public String swap(BeanSession bs, PetTag o) throws Exception {
+		return o.getName();
 	}
-
-	public String getName() {
-		return name;
-	}
-
-	public PetTag name(String name) {
-		this.name = name;
-		return this;
-	}
-
-	@Example
-	public static PetTag example() {
-		return new PetTag()
-			.id(123)
-			.name("MyTag");
-	}
-
-	public static class TagNameOnly extends PojoSwap<PetTag,String> {
-		@Override
-		public String swap(BeanSession bs, PetTag o) throws Exception {
-			return o.getName();
-		}
-		@Override
-		public MediaType[] forMediaTypes() {
-			return new MediaType[] { MediaType.HTML };
-		}
-	}
-
-	public static String asString(List<PetTag> tags) {
-		if (tags == null)
-			return "";
-		List<String> l = new ArrayList<>(tags.size());
-		for (PetTag t : tags)
-			l.add(t.getName());
-		return StringUtils.join(l, ',');
+	@Override
+	public MediaType[] forMediaTypes() {
+		return new MediaType[] { MediaType.HTML };
 	}
-}
+}
\ No newline at end of file
diff --git a/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/MicroserviceBuilder.java
b/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/MicroserviceBuilder.java
index da18f74..45b4429 100644
--- a/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/MicroserviceBuilder.java
+++ b/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/MicroserviceBuilder.java
@@ -93,7 +93,7 @@ public class MicroserviceBuilder {
 	 * Specifies the command-line arguments passed into the Java command.
 	 *
 	 * <p>
-	 * This is required if you use {@link Microservice#getArgs()} or <code>$ARG</code>
string variables.
+	 * This is required if you use {@link Microservice#getArgs()} or <code>$A</code>
string variables.
 	 *
 	 * @param args
 	 * 	The command-line arguments passed into the Java command as a pre-parsed {@link Args}
object.
@@ -108,7 +108,7 @@ public class MicroserviceBuilder {
 	 * Specifies the command-line arguments passed into the Java command.
 	 *
 	 * <p>
-	 * This is required if you use {@link Microservice#getArgs()} or <code>$ARG</code>
string variables.
+	 * This is required if you use {@link Microservice#getArgs()} or <code>$A</code>
string variables.
 	 *
 	 * @param args
 	 * 	The command-line arguments passed into the Java command as the raw command-line arguments.


Mime
View raw message