You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/07/30 14:19:14 UTC
cvs commit: jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application DefaultApplication.java
donaldp 2002/07/30 05:19:14
Modified: src/java/org/apache/avalon/phoenix/components/application
DefaultApplication.java
Log:
Decorate class with management attributes.
Submitted by: Huw Roberts <Hu...@mmlive.com>
Revision Changes Path
1.32 +18 -0 jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/DefaultApplication.java
Index: DefaultApplication.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-phoenix/src/java/org/apache/avalon/phoenix/components/application/DefaultApplication.java,v
retrieving revision 1.31
retrieving revision 1.32
diff -u -r1.31 -r1.32
--- DefaultApplication.java 26 Jul 2002 09:49:20 -0000 1.31
+++ DefaultApplication.java 30 Jul 2002 12:19:14 -0000 1.32
@@ -35,6 +35,8 @@
* represents an aggregation of blocks that act together to form
* an application.
*
+ * @phoenix:mx-topic name="Application"
+ *
* @author <a href="mailto:peter@apache.org">Peter Donald</a>
* @author <a href="mailto:leosimons@apache.org">Leo Simons</a>
*/
@@ -99,6 +101,8 @@
* This is only valid when isRunning() returns false,
* otherwise it will generate an IllegalStateException.
*
+ * @phoenix:mx-operation
+ *
* @throws IllegalStateException if application is already running
* @throws ApplicationException if the application failed to start.
* the message part of exception will contain more information
@@ -147,6 +151,8 @@
* This is equivelent to calling stop() and then start()
* in succession.
*
+ * @phoenix:mx-operation
+ *
* @throws IllegalStateException if application is not already running
* @throws ApplicationException if the application failed to stop or start.
* the message part of exception will contain more information
@@ -164,6 +170,8 @@
* This is only valid when isRunning() returns true,
* otherwise it will generate an IllegalStateException.
*
+ * @phoenix:mx-operation
+ *
* @throws IllegalStateException if application is not already running
* @throws ApplicationException if the application failed to shutdown.
* the message part of exception will contain more information
@@ -237,6 +245,8 @@
/**
* Get the name of the application.
*
+ * @phoenix:mx-attribute
+ *
* @return the name of the application
*/
public String getName()
@@ -247,6 +257,8 @@
/**
* Get the name to display in Management UI.
*
+ * @phoenix:mx-attribute
+ *
* @return the name of the application to display in UI
*/
public String getDisplayName()
@@ -257,6 +269,8 @@
/**
* Get the string used to describe the application in the UI.
*
+ * @phoenix:mx-attribute
+ *
* @return a short description of the application
*/
public String getDescription()
@@ -267,6 +281,8 @@
/**
* Get location of Application installation
*
+ * @phoenix:mx-attribute
+ *
* @return the home directory of application
*/
public String getHomeDirectory()
@@ -277,6 +293,8 @@
/**
* Return true if the application is
* running or false otherwise.
+ *
+ * @phoenix:mx-attribute
*
* @return true if application is running, false otherwise
*/
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>