Author: markt
Date: Fri Apr 17 21:37:59 2015
New Revision: 1674409
URL: http://svn.apache.org/r1674409
Log:
Javadoc fixes
Modified:
tomcat/trunk/java/org/apache/catalina/JmxEnabled.java
tomcat/trunk/java/org/apache/catalina/LifecycleEvent.java
tomcat/trunk/java/org/apache/catalina/LifecycleState.java
Modified: tomcat/trunk/java/org/apache/catalina/JmxEnabled.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/JmxEnabled.java?rev=1674409&r1=1674408&r2=1674409&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/JmxEnabled.java (original)
+++ tomcat/trunk/java/org/apache/catalina/JmxEnabled.java Fri Apr 17 21:37:59
2015
@@ -28,7 +28,7 @@ import javax.management.ObjectName;
public interface JmxEnabled extends MBeanRegistration {
/**
- * Obtain the domain under which this component will be / has been
+ * @return the domain under which this component will be / has been
* registered.
*/
String getDomain();
@@ -38,12 +38,15 @@ public interface JmxEnabled extends MBea
* Specify the domain under which this component should be registered. Used
* with components that cannot (easily) navigate the component hierarchy to
* determine the correct domain to use.
+ *
+ * @param domain The name of the domain under which this component should
be
+ * registered
*/
void setDomain(String domain);
/**
- * Obtain 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();
}
Modified: tomcat/trunk/java/org/apache/catalina/LifecycleEvent.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/LifecycleEvent.java?rev=1674409&r1=1674408&r2=1674409&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/LifecycleEvent.java (original)
+++ tomcat/trunk/java/org/apache/catalina/LifecycleEvent.java Fri Apr 17
21:37:59 2015
@@ -14,19 +14,13 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
-
package org.apache.catalina;
-
import java.util.EventObject;
-
/**
* General event for notifying listeners of significant changes on a component
- * that implements the Lifecycle interface. In particular, this will be useful
- * on Containers, where these events replace the ContextInterceptor concept in
- * Tomcat 3.x.
+ * that implements the Lifecycle interface.
*
* @author Craig R. McClanahan
*/
@@ -35,8 +29,6 @@ public final class LifecycleEvent extend
private static final long serialVersionUID = 1L;
- // ----------------------------------------------------------- Constructors
-
/**
* Construct a new LifecycleEvent with the specified parameters.
*
@@ -45,16 +37,12 @@ public final class LifecycleEvent extend
* @param data Event data (if any)
*/
public LifecycleEvent(Lifecycle lifecycle, String type, Object data) {
-
super(lifecycle);
this.type = type;
this.data = data;
}
- // ----------------------------------------------------- Instance Variables
-
-
/**
* The event data associated with this event.
*/
@@ -67,37 +55,26 @@ public final class LifecycleEvent extend
private final String type;
- // ------------------------------------------------------------- Properties
-
-
/**
- * Return the event data of this event.
+ * @return the event data of this event.
*/
public Object getData() {
-
- return (this.data);
-
+ return data;
}
/**
- * Return the Lifecycle on which this event occurred.
+ * @return the Lifecycle on which this event occurred.
*/
public Lifecycle getLifecycle() {
-
return (Lifecycle) getSource();
-
}
/**
- * Return the event type of this event.
+ * @return the event type of this event.
*/
public String getType() {
-
- return (this.type);
-
+ return this.type;
}
-
-
}
Modified: tomcat/trunk/java/org/apache/catalina/LifecycleState.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/LifecycleState.java?rev=1674409&r1=1674408&r2=1674409&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/LifecycleState.java (original)
+++ tomcat/trunk/java/org/apache/catalina/LifecycleState.java Fri Apr 17
21:37:59 2015
@@ -14,7 +14,6 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-
package org.apache.catalina;
/**
@@ -55,14 +54,14 @@ public enum LifecycleState {
* <li>{@link #STOPPING_PREP}</li>
* <li>{@link #MUST_STOP}</li>
* </ul>
+ *
+ * @return <code>true</code> if the component is available for use,
+ * otherwise <code>false</code>
*/
public boolean isAvailable() {
return available;
}
- /**
- *
- */
public String getLifecycleEvent() {
return lifecycleEvent;
}
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org
For additional commands, e-mail: dev-h...@tomcat.apache.org
