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: Javadoc fixes.
Date Fri, 07 Dec 2018 16:42:49 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 2d80de6  Javadoc fixes.
2d80de6 is described below

commit 2d80de6761d1250d901f2a59304b802b80d8a637
Author: JamesBognar <jamesbognar@apache.org>
AuthorDate: Fri Dec 7 11:42:32 2018 -0500

    Javadoc fixes.
---
 .../java/org/apache/juneau/ResourceResolver.java   |  3 +-
 juneau-doc/docs/ReleaseNotes/7.0.1.html            |  2 +-
 juneau-doc/docs/ReleaseNotes/8.0.0.html            |  8 ++--
 .../28.HtmlDocAnnotation/04.UiCustomization.html   |  2 +-
 juneau-doc/src/main/javadoc/overview.html          | 54 +++++++++++-----------
 .../apache/juneau/microservice/Microservice.java   |  4 +-
 .../microservice/jetty/JettyServerFactory.java     |  8 +---
 7 files changed, 37 insertions(+), 44 deletions(-)

diff --git a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ResourceResolver.java
b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ResourceResolver.java
index a96c864..9374a5b 100644
--- a/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ResourceResolver.java
+++ b/juneau-core/juneau-marshall/src/main/java/org/apache/juneau/ResourceResolver.java
@@ -16,7 +16,7 @@ package org.apache.juneau;
  * Class used to resolve {@link Class} objects to instances.
  */
 public interface ResourceResolver {
-	
+
 	/**
 	 * Look for constructors where the arguments passed in must match exactly.
 	 */
@@ -39,7 +39,6 @@ public interface ResourceResolver {
 	 * @param parent
 	 * 	The parent resource.
 	 * @param c The class to resolve.
-	 * @param builder The initialization configuration for the resource.
 	 * @param args Optional arguments to pass to constructor
 	 * @return The instance of that class.
 	 */
diff --git a/juneau-doc/docs/ReleaseNotes/7.0.1.html b/juneau-doc/docs/ReleaseNotes/7.0.1.html
index 90dc638..65c7558 100644
--- a/juneau-doc/docs/ReleaseNotes/7.0.1.html
+++ b/juneau-doc/docs/ReleaseNotes/7.0.1.html
@@ -134,7 +134,7 @@
 			<li>New methods on {@link oaj.microservice.Microservice}
 				<ul>
 					<li>{@link oaj.microservice.Microservice#startConsole() startConsole()}
-					<li>{@link oaj.microservice.Microservice#createConsoleCommands() createConsoleCommands()}
+					<li><code><del>createConsoleCommands()</del></code>
 					<li>{@link oaj.microservice.Microservice#getConsoleReader() getConsoleReader()}
 					<li>{@link oaj.microservice.Microservice#getConsoleWriter() getConsoleWriter()}
 				</ul>	
diff --git a/juneau-doc/docs/ReleaseNotes/8.0.0.html b/juneau-doc/docs/ReleaseNotes/8.0.0.html
index b5437a1..605afa2 100644
--- a/juneau-doc/docs/ReleaseNotes/8.0.0.html
+++ b/juneau-doc/docs/ReleaseNotes/8.0.0.html
@@ -36,7 +36,7 @@
 	<li><code>juneau-microservice</code>
 	<ul>
 		<li><b><code>juneau-microservice-core</code></b> - New. 
Contains base {@link oaj.microservice.Microservice} class.
-		<li><b><code>juneau-microservice-jetty</code></b> - New.
 Contains new {@link oaj.microservice.JettyMicroservice} class.
+		<li><b><code>juneau-microservice-jetty</code></b> - New.
 Contains new {@link oaj.microservice.jetty.JettyMicroservice} class.
 		<li><b><code>juneau-microservice-jetty-template</code></b>
- New.  Template starter project for Jetty-based microservices.
 		<li><b><code>juneau-microservice-springboot-template</code></b>
- New.  Template starter project for Spring-Boot-based microservices.
 	</ul>
@@ -80,9 +80,9 @@
 	<li>
 		New API method:
 		<ul class='doctree'>
-			<li class='jc'>{@link oaj.config.ConfigStore}
+			<li class='jc'>{@link oaj.config.store.ConfigStore}
 			<ul>
-				<li class='jm'>{@link oaj.config.ConfigStore#exists(String) exists(String)}
+				<li class='jm'>{@link oaj.config.store.ConfigStore#exists(String) exists(String)}
 			</ul>
 			
 </ul>
@@ -119,7 +119,7 @@
 <h5 class='topic w800'>juneau-microservice-jetty</h5>
 <ul class='spaced-list'>
 	<li>
-		New {@link oaj.microservice.JettyMicroservice} class replaces the previous <code>RestMicroservice</code>.
+		New {@link oaj.microservice.jetty.JettyMicroservice} class replaces the previous <code>RestMicroservice</code>.
 </ul>
 
 <h5 class='topic w800'>juneau-examples-rest</h5>
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 cdfd78c..5b2126b 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-server.UiCustomization}
+	<li class='link'>{@doc juneau-microservice.UiCustomization}
 </ul>
diff --git a/juneau-doc/src/main/javadoc/overview.html b/juneau-doc/src/main/javadoc/overview.html
index 4c34535..66688da 100644
--- a/juneau-doc/src/main/javadoc/overview.html
+++ b/juneau-doc/src/main/javadoc/overview.html
@@ -20377,7 +20377,7 @@
 </p>
 <h5 class='section'>See Also:</h5>
 <ul>
-	<li class='link'>{@doc juneau-microservice-server.UiCustomization}
+	<li class='link'>{@doc juneau-microservice.UiCustomization}
 </ul>
 </div><!-- END: 7.28.4 - juneau-rest-server.HtmlDocAnnotation.UiCustomization -->
 
@@ -23645,7 +23645,7 @@
 	# org.eclipse.jetty.util.log.class = org.eclipse.jetty.util.log.StrErrLog</cc>
 	
 	<cc># Configure Jetty to log using java-util logging</cc>
-	<ck>org.eclipse.jetty.util.log.class</ck> = <cv>org.apache.juneau.microservice.JettyLogger</cv>
+	<ck>org.eclipse.jetty.util.log.class</ck> = <cv>org.apache.juneau.microservice.jetty.JettyLogger</cv>
 	
 	<cc># Jetty logging level
 	# Possible values:  ALL, DEBUG, INFO, WARN, OFF</cc>
@@ -23819,11 +23819,11 @@
 	<br>If you open it, you'll see the following:
 </p>
 <p class='bpcode w800'>
-	<mk>Main-Class</mk>: <mv>org.apache.juneau.microservice.RestMicroservice</mv>
+	<mk>Main-Class</mk>: <mv>org.apache.juneau.microservice.jetty.RestMicroservice</mv>
 	<mk>Main-ConfigFile</mk>: <mv>my-microservice.cfg</mv>
 <p>
  	The <mk>Main-Class</mk> entry is the standard manifest entry describing the
entry point for the executable jar.
- 	<br>In most cases, this value will always be <l>org.apache.juneau.microservice.RestMicroservice</l>.
+ 	<br>In most cases, this value will always be <l>org.apache.juneau.microservice.jetty.RestMicroservice</l>.
  	<br>However, it is possible to extend this class or implement your own microservice,
in which case you'll need
  	to modify this value to point to the new class.
 </p>
@@ -24300,7 +24300,7 @@
 
 <h5 class='figure'>OSGi Module</h5>
 <p class='bpcode w500'>
-	org.apache.juneau.microservice.server_{@property juneauVersion}.jar 
+	org.apache.juneau.microservice.jetty.server_{@property juneauVersion}.jar 
 </p>	
 
 <h5 class='figure'>Microservice Starter Project</h5>
@@ -24503,7 +24503,7 @@
 	# org.eclipse.jetty.util.log.class = org.eclipse.jetty.util.log.StrErrLog</cc>
 	
 	<cc># Configure Jetty to log using java-util logging</cc>
-	<ck>org.eclipse.jetty.util.log.class</ck> = <cv>org.apache.juneau.microservice.JettyLogger</cv>
+	<ck>org.eclipse.jetty.util.log.class</ck> = <cv>org.apache.juneau.microservice.jetty.JettyLogger</cv>
 	
 	<cc># Jetty logging level
 	# Possible values:  ALL, DEBUG, INFO, WARN, OFF</cc>
@@ -24677,11 +24677,11 @@
 	<br>If you open it, you'll see the following:
 </p>
 <p class='bpcode w800'>
-	<mk>Main-Class</mk>: <mv>org.apache.juneau.microservice.RestMicroservice</mv>
+	<mk>Main-Class</mk>: <mv>org.apache.juneau.microservice.jetty.RestMicroservice</mv>
 	<mk>Main-ConfigFile</mk>: <mv>my-microservice.cfg</mv>
 <p>
  	The <mk>Main-Class</mk> entry is the standard manifest entry describing the
entry point for the executable jar.
- 	<br>In most cases, this value will always be <l>org.apache.juneau.microservice.RestMicroservice</l>.
+ 	<br>In most cases, this value will always be <l>org.apache.juneau.microservice.jetty.RestMicroservice</l>.
  	<br>However, it is possible to extend this class or implement your own microservice,
in which case you'll need
  	to modify this value to point to the new class.
 </p>
@@ -25158,7 +25158,7 @@
 
 <h5 class='figure'>OSGi Module</h5>
 <p class='bpcode w500'>
-	org.apache.juneau.microservice.server_{@property juneauVersion}.jar 
+	org.apache.juneau.microservice.jetty.server_{@property juneauVersion}.jar 
 </p>	
 
 <h5 class='figure'>Microservice Starter Project</h5>
@@ -30402,7 +30402,7 @@
 	<li>Completely revamped API.
 	<li>New {@link org.apache.juneau.microservice.Microservice} class that serves as a
generic
 		interface for microservices and their lifecycles.
-	<li>New {@link org.apache.juneau.microservice.RestMicroservice} class that implements
a microservice
+	<li>New <code><del>RestMicroservice</del></code> class that
implements a microservice
 		consisting of a REST interface.
 		<ul>
 			<li>REST resources and configuration settings can be defined through either manifest
files
@@ -31218,10 +31218,10 @@
 <ul class='spaced-list'>
 	<li><js>"REST/port"</js> configuration setting can now be a comma-limited
list of port numbers to try.
 		<br>You can also specify one or more <code>0</code>s to try a random
port.
-	<li>Methods added to {@link org.apache.juneau.microservice.RestMicroservice} class:
+	<li>Methods added to <code><del>RestMicroservice</del></code>
class:
 	<ul>
-		<li>{@link org.apache.juneau.microservice.RestMicroservice#getPort()}
-		<li>{@link org.apache.juneau.microservice.RestMicroservice#getURI()}
+		<li><code><del>getPort()</del></code>
+		<li><code><del>getURI()</del></code>
 		<li>Override methods added from {@link org.apache.juneau.microservice.Microservice}
class for easier method chaining.
 	</ul>
 </ul>
@@ -32314,16 +32314,16 @@
 		for maximum flexibility instead of the hodge-podge of support in the config file.
 		<br>Top-level servlets should now be defined in the provided <code>jetty.xml</code>
file.
 	<li>
-		New methods on {@link org.apache.juneau.microservice.RestMicroservice}:
+		New methods on <code><del>RestMicroservice</del></code>:
 		<ul>
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#addServlet(Servlet,String)
addServlet(Servlet,String)}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#addServletAttribute(String,Object)
addServletAttribute(String,Object)}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getServer() getServer()}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getInstance() getInstance()}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getPort() getPort()}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getContextPath() getContextPath()}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getProtocol() getProtocol()}
-			<li>{@link org.apache.juneau.microservice.RestMicroservice#getHostName() getHostName()}
+			<li><code><del>addServlet(Servlet,String)</del></code>
+			<li><code><del>addServletAttribute(String,Object)</del></code>
+			<li><code><del>getServer()</del></code>
+			<li><code><del>getInstance()</del></code>
+			<li><code><del>getPort()</del></code>
+			<li><code><del>getContextPath()</del></code>
+			<li><code><del>getProtocol()</del></code>
+			<li><code><del>getHostName()</del></code>
 		</ul>
 	<li>
 		New methods on {@link org.apache.juneau.microservice.Microservice}:
@@ -32512,7 +32512,7 @@
 			<li>New methods on {@link org.apache.juneau.microservice.Microservice}
 				<ul>
 					<li>{@link org.apache.juneau.microservice.Microservice#startConsole() startConsole()}
-					<li>{@link org.apache.juneau.microservice.Microservice#createConsoleCommands()
createConsoleCommands()}
+					<li><code><del>createConsoleCommands()</del></code>
 					<li>{@link org.apache.juneau.microservice.Microservice#getConsoleReader() getConsoleReader()}
 					<li>{@link org.apache.juneau.microservice.Microservice#getConsoleWriter() getConsoleWriter()}
 				</ul>	
@@ -33675,7 +33675,7 @@
 	<li><code>juneau-microservice</code>
 	<ul>
 		<li><b><code>juneau-microservice-core</code></b> - New. 
Contains base {@link org.apache.juneau.microservice.Microservice} class.
-		<li><b><code>juneau-microservice-jetty</code></b> - New.
 Contains new {@link org.apache.juneau.microservice.JettyMicroservice} class.
+		<li><b><code>juneau-microservice-jetty</code></b> - New.
 Contains new {@link org.apache.juneau.microservice.jetty.JettyMicroservice} class.
 		<li><b><code>juneau-microservice-jetty-template</code></b>
- New.  Template starter project for Jetty-based microservices.
 		<li><b><code>juneau-microservice-springboot-template</code></b>
- New.  Template starter project for Spring-Boot-based microservices.
 	</ul>
@@ -33719,9 +33719,9 @@
 	<li>
 		New API method:
 		<ul class='doctree'>
-			<li class='jc'>{@link org.apache.juneau.config.ConfigStore}
+			<li class='jc'>{@link org.apache.juneau.config.store.ConfigStore}
 			<ul>
-				<li class='jm'>{@link org.apache.juneau.config.ConfigStore#exists(String) exists(String)}
+				<li class='jm'>{@link org.apache.juneau.config.store.ConfigStore#exists(String)
exists(String)}
 			</ul>
 			
 </ul>
@@ -33758,7 +33758,7 @@
 <h5 class='topic w800'>juneau-microservice-jetty</h5>
 <ul class='spaced-list'>
 	<li>
-		New {@link org.apache.juneau.microservice.JettyMicroservice} class replaces the previous
<code>RestMicroservice</code>.
+		New {@link org.apache.juneau.microservice.jetty.JettyMicroservice} class replaces the previous
<code>RestMicroservice</code>.
 </ul>
 
 <h5 class='topic w800'>juneau-examples-rest</h5>
diff --git a/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/Microservice.java
b/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/Microservice.java
index fa84f08..773b1c0 100755
--- a/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/Microservice.java
+++ b/juneau-microservice/juneau-microservice-core/src/main/java/org/apache/juneau/microservice/Microservice.java
@@ -728,7 +728,7 @@ public class Microservice implements ConfigEventListener {
 	 * @param messageKey The message key.
 	 * @param args Optional {@link MessageFormat}-style arguments.
 	 */
-	protected void out(MessageBundle mb, String messageKey, Object...args) {
+	public void out(MessageBundle mb, String messageKey, Object...args) {
 		String msg = mb.getString(messageKey, args);
 		if (consoleEnabled)
 			getConsoleWriter().println(msg);
@@ -745,7 +745,7 @@ public class Microservice implements ConfigEventListener {
 	 * @param messageKey The message key.
 	 * @param args Optional {@link MessageFormat}-style arguments.
 	 */
-	protected void err(MessageBundle mb, String messageKey, Object...args) {
+	public void err(MessageBundle mb, String messageKey, Object...args) {
 		String msg = mb.getString(messageKey, args);
 		if (consoleEnabled)
 			System.err.println(mb.getString(messageKey, args));  // NOT DEBUG
diff --git a/juneau-microservice/juneau-microservice-jetty/src/main/java/org/apache/juneau/microservice/jetty/JettyServerFactory.java
b/juneau-microservice/juneau-microservice-jetty/src/main/java/org/apache/juneau/microservice/jetty/JettyServerFactory.java
index 4beb98b..ac03187 100644
--- a/juneau-microservice/juneau-microservice-jetty/src/main/java/org/apache/juneau/microservice/jetty/JettyServerFactory.java
+++ b/juneau-microservice/juneau-microservice-jetty/src/main/java/org/apache/juneau/microservice/jetty/JettyServerFactory.java
@@ -22,13 +22,7 @@ public interface JettyServerFactory {
 	/**
 	 * Create a new initialized Jetty server.
 	 *
-	 * @param config The microservice INI file.
-	 * @param manifestFile The microservice. manifest file.
-	 * @param varResolver The microservice variable resolver.
-	 * @param logger The microservice logger.
-	 * @param ports Requested ports to use.  Can be <jk>null</jk>.
-	 * @param jettyXml The contents of the <code>jetty.xml</code> file.
-	 * @param resolveVars Whether we should resolve SVL variables in the <code>jetty.xml</code>
file.
+	 * @param jettyXml The contents of the jetty.xml file.
 	 * @return A newly-created but not-yet-started server.
 	 * @throws Exception
 	 */


Mime
View raw message