Author: markt
Date: Fri Apr 17 21:33:09 2015
New Revision: 1674408
URL: http://svn.apache.org/r1674408
Log:
Javadoc fixes
Modified:
tomcat/trunk/java/org/apache/catalina/Engine.java
tomcat/trunk/java/org/apache/catalina/Executor.java
tomcat/trunk/java/org/apache/catalina/Group.java
Modified: tomcat/trunk/java/org/apache/catalina/Engine.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Engine.java?rev=1674408&r1=1674407&r2=1674408&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Engine.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Engine.java Fri Apr 17 21:33:09 2015
@@ -14,8 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.catalina;
/**
@@ -44,12 +42,8 @@ package org.apache.catalina;
*/
public interface Engine extends Container {
-
- // ------------------------------------------------------------- Properties
-
-
/**
- * Return the default hostname for this Engine.
+ * @return the default host name for this Engine.
*/
public String getDefaultHost();
@@ -63,7 +57,7 @@ public interface Engine extends Containe
/**
- * Retrieve the JvmRouteId for this engine.
+ * @return the JvmRouteId for this engine.
*/
public String getJvmRoute();
@@ -78,7 +72,7 @@ public interface Engine extends Containe
/**
- * Return the <code>Service</code> with which we are associated (if any).
+ * @return the <code>Service</code> with which we are associated (if any).
*/
public Service getService();
@@ -89,6 +83,4 @@ public interface Engine extends Containe
* @param service The service that owns this Engine
*/
public void setService(Service service);
-
-
}
Modified: tomcat/trunk/java/org/apache/catalina/Executor.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Executor.java?rev=1674408&r1=1674407&r2=1674408&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Executor.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Executor.java Fri Apr 17 21:33:09 2015
@@ -18,8 +18,8 @@ package org.apache.catalina;
import java.util.concurrent.TimeUnit;
-
public interface Executor extends java.util.concurrent.Executor, Lifecycle {
+
public String getName();
/**
@@ -31,6 +31,9 @@ public interface Executor extends java.u
* time until it throws a RejectedExecutionException
*
* @param command the runnable task
+ * @param timeout the length of time to wait for the task to complete
+ * @param unit the units in which timeout is expressed
+ *
* @throws java.util.concurrent.RejectedExecutionException if this task
* cannot be accepted for execution - the queue is full
* @throws NullPointerException if command or unit is null
Modified: tomcat/trunk/java/org/apache/catalina/Group.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/Group.java?rev=1674408&r1=1674407&r2=1674408&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/Group.java (original)
+++ tomcat/trunk/java/org/apache/catalina/Group.java Fri Apr 17 21:33:09 2015
@@ -14,15 +14,11 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.catalina;
-
import java.security.Principal;
import java.util.Iterator;
-
/**
* <p>Abstract representation of a group of {@link User}s in a
* {@link UserDatabase}. Each user that is a member of this group
@@ -33,12 +29,10 @@ import java.util.Iterator;
*/
public interface Group extends Principal {
-
// ------------------------------------------------------------- Properties
-
/**
- * Return the description of this group.
+ * @return the description of this group.
*/
public String getDescription();
@@ -52,7 +46,7 @@ public interface Group extends Principal
/**
- * Return the group name of this group, which must be unique
+ * @return the group name of this group, which must be unique
* within the scope of a {@link UserDatabase}.
*/
public String getGroupname();
@@ -68,26 +62,25 @@ public interface Group extends Principal
/**
- * Return the set of {@link Role}s assigned specifically to this group.
+ * @return the set of {@link Role}s assigned specifically to this group.
*/
public Iterator<Role> getRoles();
/**
- * Return the {@link UserDatabase} within which this Group is defined.
+ * @return the {@link UserDatabase} within which this Group is defined.
*/
public UserDatabase getUserDatabase();
/**
- * Return the set of {@link User}s that are members of this group.
+ * @return the set of {@link User}s that are members of this group.
*/
public Iterator<User> getUsers();
// --------------------------------------------------------- Public Methods
-
/**
* Add a new {@link Role} to those assigned specifically to this group.
*
@@ -100,6 +93,9 @@ public interface Group extends Principal
* Is this group specifically assigned the specified {@link Role}?
*
* @param role The role to check
+ *
+ * @return <code>true</code> if the group is assigned to the specified role
+ * otherwise <code>false</code>
*/
public boolean isInRole(Role role);
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
