This is an automated email from the ASF dual-hosted git repository.
markt pushed a commit to branch 7.0.x
in repository https://gitbox.apache.org/repos/asf/tomcat.git
commit 9d18f8811431afbc597b4e34ceaff2917829e2cb
Author: Mark Thomas <ma...@apache.org>
AuthorDate: Fri Sep 27 14:03:31 2019 +0100
Align Javadoc and method order with 8.5.x.
---
java/org/apache/catalina/Host.java | 64 +++++++++++++++++++++-----------------
1 file changed, 36 insertions(+), 28 deletions(-)
diff --git a/java/org/apache/catalina/Host.java
b/java/org/apache/catalina/Host.java
index 512a49c..fc645a3 100644
--- a/java/org/apache/catalina/Host.java
+++ b/java/org/apache/catalina/Host.java
@@ -66,9 +66,9 @@ public interface Host extends Container {
/**
- * Return the XML root for this Host. This can be an absolute
+ * @return the XML root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
- * If null, defaults to
+ * If null, the base path defaults to
* ${catalina.base}/conf/<engine name>/<host name> directory
*/
public String getXmlBase();
@@ -76,14 +76,14 @@ public interface Host extends Container {
/**
* Set the Xml root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
- * If null, defaults to
+ * If null, the base path defaults to
* ${catalina.base}/conf/<engine name>/<host name> directory
* @param xmlBase The new XML root
*/
public void setXmlBase(String xmlBase);
/**
- * Return the application root for this Host. This can be an absolute
+ * @return the application root for this Host. This can be an absolute
* pathname, a relative pathname, or a URL.
*/
public String getAppBase();
@@ -99,7 +99,7 @@ public interface Host extends Container {
/**
- * Return the value of the auto deploy flag. If true, it indicates that
+ * @return the value of the auto deploy flag. If true, it indicates that
* this host's child webapps should be discovered and automatically
* deployed dynamically.
*/
@@ -115,7 +115,7 @@ public interface Host extends Container {
/**
- * Return the Java class name of the context configuration class
+ * @return the Java class name of the context configuration class
* for new web applications.
*/
public String getConfigClass();
@@ -131,7 +131,7 @@ public interface Host extends Container {
/**
- * Return the value of the deploy on startup flag. If true, it indicates
+ * @return the value of the deploy on startup flag. If true, it indicates
* that this host's child webapps should be discovered and automatically
* deployed.
*/
@@ -147,7 +147,7 @@ public interface Host extends Container {
/**
- * Return the regular expression that defines the files and directories in
+ * @return the regular expression that defines the files and directories in
* the host's appBase that will be ignored by the automatic deployment
* process.
*/
@@ -155,7 +155,7 @@ public interface Host extends Container {
/**
- * Return the compiled regular expression that defines the files and
+ * @return the compiled regular expression that defines the files and
* directories in the host's appBase that will be ignored by the automatic
* deployment process.
*/
@@ -166,12 +166,14 @@ public interface Host extends Container {
* Set the regular expression that defines the files and directories in
* the host's appBase that will be ignored by the automatic deployment
* process.
+ *
+ * @param deployIgnore A regular expression matching file names
*/
public void setDeployIgnore(String deployIgnore);
/**
- * Return the executor that is used for starting and stopping contexts.
This
+ * @return the executor that is used for starting and stopping contexts.
This
* is primarily for use by components deploying contexts that want to do
* this in a multi-threaded manner.
*/
@@ -179,17 +181,36 @@ public interface Host extends Container {
/**
- * Returns true of the Host is configured to automatically undeploy old
+ * Returns <code>true</code> if the Host will attempt to create
directories for appBase and xmlBase
+ * unless they already exist.
+ * @return true if the Host will attempt to create directories
+ */
+ public boolean getCreateDirs();
+
+
+ /**
+ * Should the Host attempt to create directories for xmlBase and appBase
+ * upon startup.
+ *
+ * @param createDirs The new value for this flag
+ */
+ public void setCreateDirs(boolean createDirs);
+
+
+ /**
+ * @return <code>true</code> of the Host is configured to automatically
undeploy old
* versions of applications deployed using parallel deployment. This only
- * takes effect is {@link #getAutoDeploy()} also returns true.
+ * takes effect is {@link #getAutoDeploy()} also returns <code>true</code>.
*/
public boolean getUndeployOldVersions();
/**
- * Set to true if the Host should automatically undeploy old versions of
+ * Set to <code>true</code> if the Host should automatically undeploy old
versions of
* applications deployed using parallel deployment. This only takes effect
- * if {@link #getAutoDeploy()} returns true.
+ * if {@link #getAutoDeploy()} returns <code>true</code>.
+ *
+ * @param undeployOldVersions The new value for this flag
*/
public void setUndeployOldVersions(boolean undeployOldVersions);
@@ -205,7 +226,7 @@ public interface Host extends Container {
/**
- * Return the set of alias names for this Host. If none are defined,
+ * @return the set of alias names for this Host. If none are defined,
* a zero length array is returned.
*/
public String[] findAliases();
@@ -217,17 +238,4 @@ public interface Host extends Container {
* @param alias Alias name to be removed
*/
public void removeAlias(String alias);
-
- /**
- * Returns true if the Host will attempt to create directories for appBase
and xmlBase
- * unless they already exist.
- * @return true if the Host will attempt to create directories
- */
- public boolean getCreateDirs();
- /**
- * Set to true if the Host should attempt to create directories for
xmlBase and appBase upon startup
- * @param createDirs
- */
- public void setCreateDirs(boolean createDirs);
-
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
