Add javadoc

Author: rmaucher

java/org/apache/catalina/AccessLog.java

@@ -82,6 +82,8 @@ public interface AccessLog {
     void setRequestAttributesEnabled(boolean requestAttributesEnabled);
 
     /**
+     * Checks if request attributes will be logged.
+     *
      * @see #setRequestAttributesEnabled(boolean)
      *
      * @return <code>true</code> if the attributes will be logged, otherwise <code>false</code>

java/org/apache/catalina/Context.java

@@ -60,7 +60,6 @@
  * <p>
  * The child containers attached to a Context are generally implementations of Wrapper (representing individual servlet
  * definitions).
- * <p>
  */
 public interface Context extends Container, ContextBind {
 

java/org/apache/catalina/JmxEnabled.java

@@ -27,6 +27,8 @@
 public interface JmxEnabled extends MBeanRegistration {
 
     /**
+     * Returns the domain under which this component will be / has been registered.
+     *
      * @return the domain under which this component will be / has been registered.
      */
     String getDomain();
@@ -42,6 +44,8 @@ public interface JmxEnabled extends MBeanRegistration {
 
 
     /**
+     * Returns the name under which this component has been registered with JMX.
+     *
      * @return the name under which this component has been registered with JMX.
      */
     ObjectName getObjectName();

java/org/apache/catalina/WebResource.java

@@ -26,17 +26,23 @@
  */
 public interface WebResource {
     /**
+     * Returns the last modified time.
+     *
      * @return {@link java.io.File#lastModified()}.
      */
     long getLastModified();
 
     /**
+     * Returns the last modified time in HTTP format.
+     *
      * @return the last modified time of this resource in the correct format for the HTTP Last-Modified header as
      *             specified by RFC 2616.
      */
     String getLastModifiedHttp();
 
     /**
+     * Checks if this resource exists.
+     *
      * @return {@link java.io.File#exists()}.
      */
     boolean exists();
@@ -51,48 +57,64 @@ public interface WebResource {
     boolean isVirtual();
 
     /**
+     * Checks if this resource is a directory.
+     *
      * @return {@link java.io.File#isDirectory()}.
      */
     boolean isDirectory();
 
     /**
+     * Checks if this resource is a file.
+     *
      * @return {@link java.io.File#isFile()}.
      */
     boolean isFile();
 
     /**
+     * Deletes this resource.
+     *
      * @return {@link java.io.File#delete()}.
      */
     boolean delete();
 
     /**
+     * Returns the name of this resource.
+     *
      * @return {@link java.io.File#getName()}.
      */
     String getName();
 
     /**
+     * Returns the content length of this resource.
+     *
      * @return {@link java.io.File#length()}.
      */
     long getContentLength();
 
     /**
+     * Returns the canonical path of this resource.
+     *
      * @return {@link java.io.File#getCanonicalPath()}.
      */
     String getCanonicalPath();
 
     /**
+     * Checks if this resource can be read.
+     *
      * @return {@link java.io.File#canRead()}.
      */
     boolean canRead();
 
     /**
+     * Returns the webapp path of this resource.
+     *
      * @return The path of this resource relative to the web application root. If the resource is a directory, the
      *             return value will end in '/'.
      */
     String getWebappPath();
 
     /**
-     * Return the weak ETag calculated from the content length and last modified.
+     * Returns the weak ETag calculated from the content length and last modified.
      *
      * @return The ETag for this resource
      */
@@ -116,31 +138,39 @@ default String getStrongETag() {
     void setMimeType(String mimeType);
 
     /**
+     * Returns the MIME type for this Resource.
+     *
      * @return the MIME type for this Resource.
      */
     String getMimeType();
 
     /**
-     * Obtain an InputStream based on the contents of this resource.
+     * Obtains an InputStream based on the contents of this resource.
      *
      * @return An InputStream based on the contents of this resource or <code>null</code> if the resource does not exist
      *             or does not represent a file
      */
     InputStream getInputStream();
 
     /**
+     * Returns the binary content of this resource.
+     *
      * @return the binary content of this resource or {@code null} if it is not available in a byte[] because, for
      *             example, it is too big.
      */
     byte[] getContent();
 
     /**
+     * Returns the creation time of this resource.
+     *
      * @return The time the file was created. If not available, the result of {@link #getLastModified()} will be
      *             returned.
      */
     long getCreation();
 
     /**
+     * Returns a URL to access this resource.
+     *
      * @return a URL to access the resource or <code>null</code> if no such URL is available or if the resource does not
      *             exist.
      */
@@ -160,18 +190,24 @@ default URL getCodeBase() {
     }
 
     /**
+     * Returns a reference to the WebResourceRoot of which this WebResource is a part.
+     *
      * @return a reference to the WebResourceRoot of which this WebResource is a part.
      */
     WebResourceRoot getWebResourceRoot();
 
     /**
+     * Returns the certificates that were used to sign this resource to verify it.
+     *
      * @return the certificates that were used to sign this resource to verify it or @null if none.
      *
      * @see java.util.jar.JarEntry#getCertificates()
      */
     Certificate[] getCertificates();
 
     /**
+     * Returns the manifest associated with this resource.
+     *
      * @return the manifest associated with this resource or @null if none.
      *
      * @see java.util.jar.JarFile#getManifest()

java/org/apache/catalina/WebResourceRoot.java

@@ -207,6 +207,8 @@ void createWebResourceSet(ResourceSetType type, String webAppMount, String base,
     void addPreResources(WebResourceSet webResourceSet);
 
     /**
+     * Returns the array of WebResourceSet configured to this web application as a 'Pre' resource.
+     *
      * @return the array of WebResourceSet configured to this web application as a 'Pre' resource.
      */
     WebResourceSet[] getPreResources();
@@ -219,6 +221,8 @@ void createWebResourceSet(ResourceSetType type, String webAppMount, String base,
     void addJarResources(WebResourceSet webResourceSet);
 
     /**
+     * Returns the array of WebResourceSet configured to this web application as a 'Jar' resource.
+     *
      * @return the array of WebResourceSet configured to this web application as a 'Jar' resource.
      */
     WebResourceSet[] getJarResources();
@@ -231,11 +235,15 @@ void createWebResourceSet(ResourceSetType type, String webAppMount, String base,
     void addPostResources(WebResourceSet webResourceSet);
 
     /**
+     * Returns the array of WebResourceSet configured to this web application as a 'Post' resource.
+     *
      * @return the array of WebResourceSet configured to this web application as a 'Post' resource.
      */
     WebResourceSet[] getPostResources();
 
     /**
+     * Returns the web application this WebResourceRoot is associated with.
+     *
      * @return the web application this WebResourceRoot is associated with.
      */
     Context getContext();
@@ -271,6 +279,8 @@ void createWebResourceSet(ResourceSetType type, String webAppMount, String base,
     void setCachingAllowed(boolean cachingAllowed);
 
     /**
+     * Checks if caching is permitted for this web application.
+     *
      * @return <code>true</code> if caching is permitted for this web application.
      */
     boolean isCachingAllowed();
@@ -428,6 +438,8 @@ default void setReadOnly(boolean readOnly) {
     }
 
     /**
+     * Checks if the main resources are read only.
+     *
      * @return {@code true} if the main resources are read only, otherwise {@code false}. The default implementation
      *             returns {@code false}.
      */

java/org/apache/catalina/ant/AbstractCatalinaCommandTask.java

@@ -21,17 +21,30 @@
 
 import org.apache.tools.ant.BuildException;
 
+/**
+ * Abstract task for Catalina commands.
+ */
 public abstract class AbstractCatalinaCommandTask extends AbstractCatalinaTask {
 
     /**
      * The context path of the web application we are managing.
      */
     protected String path = null;
 
+    /**
+     * Returns the path.
+     *
+     * @return the path
+     */
     public String getPath() {
         return this.path;
     }
 
+    /**
+     * Sets the path.
+     *
+     * @param path The path to set
+     */
     public void setPath(String path) {
         this.path = path;
     }
@@ -41,10 +54,20 @@ public void setPath(String path) {
      */
     protected String version = null;
 
+    /**
+     * Returns the version.
+     *
+     * @return the version
+     */
     public String getVersion() {
         return this.version;
     }
 
+    /**
+     * Sets the version.
+     *
+     * @param version The version to set
+     */
     public void setVersion(String version) {
         this.version = version;
     }

java/org/apache/catalina/ha/tcp/SendMessageData.java

@@ -19,6 +19,8 @@
 import org.apache.catalina.tribes.Member;
 
 /**
+ * Data about a message send operation.
+ *
  * @param message     The message that was sent
  * @param destination The destination of the message
  * @param exception   The exception, if any, when attempting to send the message

java/org/apache/catalina/tribes/group/AbsoluteOrder.java

@@ -46,32 +46,57 @@
  * @see org.apache.catalina.tribes.Member
  */
 public class AbsoluteOrder {
+    /**
+     * The comparator for absolute order.
+     */
     public static final AbsoluteComparator comp = new AbsoluteComparator();
 
+    /**
+     * Protected constructor.
+     */
     protected AbsoluteOrder() {
         super();
     }
 
 
+    /**
+     * Sort the members in absolute order.
+     *
+     * @param members The members to sort
+     */
     public static void absoluteOrder(Member[] members) {
         if (members == null || members.length <= 1) {
             return;
         }
         Arrays.sort(members, comp);
     }
 
+    /**
+     * Sort the members in absolute order.
+     *
+     * @param members The members to sort
+     */
     public static void absoluteOrder(List<Member> members) {
         if (members == null || members.size() <= 1) {
             return;
         }
         members.sort(comp);
     }
 
+    /**
+     * A comparator for absolute ordering of members.
+     */
     public static class AbsoluteComparator implements Comparator<Member>, Serializable {
 
         @Serial
         private static final long serialVersionUID = 1L;
 
+        /**
+         * Default constructor.
+         */
+        public AbsoluteComparator() {
+        }
+
         @Override
         public int compare(Member m1, Member m2) {
             int result = compareIps(m1, m2);

java/org/apache/catalina/tribes/tipis/AbstractReplicatedMap.java

@@ -50,6 +50,8 @@
 import org.apache.juli.logging.LogFactory;
 
 /**
+ * An abstract replicated map implementation.
+ *
  * @param <K> The type of Key
  * @param <V> The type of Value
  */