tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ma...@apache.org
Subject svn commit: r1641486 - in /tomcat/trunk/java/org/apache/catalina: Context.java core/StandardContext.java
Date Mon, 24 Nov 2014 21:58:54 GMT
Author: markt
Date: Mon Nov 24 21:58:54 2014
New Revision: 1641486

URL: http://svn.apache.org/r1641486
Log:
A handful of Java 8 Javadoc clean-ups

Modified:
    tomcat/trunk/java/org/apache/catalina/Context.java
    tomcat/trunk/java/org/apache/catalina/core/StandardContext.java

Modified: tomcat/trunk/java/org/apache/catalina/Context.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Context.java?rev=1641486&r1=1641485&r2=1641486&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Context.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Context.java Mon Nov 24 21:58:54 2014
@@ -109,12 +109,11 @@ public interface Context extends Contain
 
 
     /**
-     * Return the set of initialized application event listener objects,
-     * in the order they were specified in the web application deployment
-     * descriptor, for this application.
+     * Obtain the registered application event listeners.
      *
-     * @exception IllegalStateException if this method is called before
-     *  this application has started, or after it has been stopped
+     * @return An array containing the application event listener instances for
+     *         this web application in the order they were specified in the web
+     *         application deployment descriptor
      */
     public Object[] getApplicationEventListeners();
 
@@ -130,12 +129,11 @@ public interface Context extends Contain
 
 
     /**
-     * Return the set of initialized application lifecycle listener objects,
-     * in the order they were specified in the web application deployment
-     * descriptor, for this application.
+     * Obtain the registered application lifecycle listeners.
      *
-     * @exception IllegalStateException if this method is called before
-     *  this application has started, or after it has been stopped
+     * @return An array containing the application lifecycle listener instances
+     *         for this web application in the order they were specified in the
+     *         web application deployment descriptor
      */
     public Object[] getApplicationLifecycleListeners();
 
@@ -154,12 +152,19 @@ public interface Context extends Contain
      * Obtain the character set name to use with the given Locale. Note that
      * different Contexts may have different mappings of Locale to character
      * set.
+     *
+     * @param locale The locale for which the mapped character set should be
+     *               returned
+     *
+     * @return The name of the character set to use with the given Locale
      */
     public String getCharset(Locale locale);
 
 
     /**
      * Return the URL of the XML descriptor for this context.
+     *
+     * @return The URL of the XML descriptor for this context
      */
     public URL getConfigFile();
 
@@ -174,6 +179,9 @@ public interface Context extends Contain
 
     /**
      * Return the "correctly configured" flag for this Context.
+     *
+     * @return <code>true</code> if the Context has been correctly configured,
+     *         otherwise <code>false</code>
      */
     public boolean getConfigured();
 
@@ -190,6 +198,10 @@ public interface Context extends Contain
 
     /**
      * Return the "use cookies for session ids" flag.
+     *
+     * @return <code>true</code> if it is permitted to use cookies to track
+     *         session IDs for this web application, otherwise
+     *         <code>false</code>
      */
     public boolean getCookies();
 
@@ -303,6 +315,9 @@ public interface Context extends Contain
 
     /**
      * Return the "allow crossing servlet contexts" flag.
+     *
+     * @return <code>true</code> if cross-contest requests are allowed from this
+     *         web applications, otherwise <code>false</code>
      */
     public boolean getCrossContext();
 

Modified: tomcat/trunk/java/org/apache/catalina/core/StandardContext.java
URL: http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/core/StandardContext.java?rev=1641486&r1=1641485&r2=1641486&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/core/StandardContext.java (original)
+++ tomcat/trunk/java/org/apache/catalina/core/StandardContext.java Mon Nov 24 21:58:54 2014
@@ -1162,27 +1162,12 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * Return the set of initialized application event listener objects,
-     * in the order they were specified in the web application deployment
-     * descriptor, for this application.
-     *
-     * @exception IllegalStateException if this method is called before
-     *  this application has started, or after it has been stopped
-     */
     @Override
     public Object[] getApplicationEventListeners() {
         return (applicationEventListenersObjects);
     }
 
 
-    /**
-     * Store the set of initialized application event listener objects,
-     * in the order they were specified in the web application deployment
-     * descriptor, for this application.
-     *
-     * @param listeners The set of instantiated listener objects.
-     */
     @Override
     public void setApplicationEventListeners(Object listeners[]) {
         applicationEventListenersObjects = listeners;
@@ -1202,14 +1187,6 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * Return the set of initialized application lifecycle listener objects,
-     * in the order they were specified in the web application deployment
-     * descriptor, for this application.
-     *
-     * @exception IllegalStateException if this method is called before
-     *  this application has started, or after it has been stopped
-     */
     @Override
     public Object[] getApplicationLifecycleListeners() {
         return (applicationLifecycleListenersObjects);
@@ -1312,37 +1289,21 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * Return the URL of the XML descriptor for this context.
-     */
     @Override
     public URL getConfigFile() {
-
-        return (this.configFile);
-
+        return this.configFile;
     }
 
 
-    /**
-     * Set the URL of the XML descriptor for this context.
-     *
-     * @param configFile The URL of the XML descriptor for this context.
-     */
     @Override
     public void setConfigFile(URL configFile) {
-
         this.configFile = configFile;
     }
 
 
-    /**
-     * Return the "correctly configured" flag for this Context.
-     */
     @Override
     public boolean getConfigured() {
-
-        return (this.configured);
-
+        return this.configured;
     }
 
 
@@ -1365,14 +1326,9 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * Return the "use cookies for session ids" flag.
-     */
     @Override
     public boolean getCookies() {
-
-        return (this.cookies);
-
+        return this.cookies;
     }
 
 
@@ -1519,14 +1475,9 @@ public class StandardContext extends Con
     }
 
 
-    /**
-     * Return the "allow crossing servlet contexts" flag.
-     */
     @Override
     public boolean getCrossContext() {
-
-        return (this.crossContext);
-
+        return this.crossContext;
     }
 
 



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message