morpheus 2002/06/07 18:40:05
Modified: src/java/org/apache/avalon/framework/service
DefaultServiceManager.java
Log:
Cleaned up JavaDoc.
Revision Changes Path
1.5 +18 -16
jakarta-avalon/src/java/org/apache/avalon/framework/service/DefaultServiceManager.java
Index: DefaultServiceManager.java
===================================================================
RCS file:
/home/cvs/jakarta-avalon/src/java/org/apache/avalon/framework/service/DefaultServiceManager.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- DefaultServiceManager.java 10 May 2002 03:00:48 -0000 1.4
+++ DefaultServiceManager.java 8 Jun 2002 01:40:05 -0000 1.5
@@ -12,8 +12,8 @@
import java.util.Map;
/**
- * This class is a static implementation of a ServiceManager. Allow
ineritance
- * and extension so you can generate a tree of ServiceManager each defining
+ * This class is a static implementation of a <code>ServiceManager</code>.
Allow ineritance
+ * and extension so you can generate a tree of <code>ServiceManager</code>
each defining
* Object scope.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Federico Barbieri</a>
@@ -29,7 +29,7 @@
private boolean m_readOnly;
/**
- * Construct ServiceManager with no parent.
+ * Construct <code>ServiceManager</code> with no parent.
*
*/
public DefaultServiceManager()
@@ -38,9 +38,9 @@
}
/**
- * Construct ServiceManager with specified parent.
+ * Construct <code>ServiceManager</code> with specified parent.
*
- * @param parent the ServiceManager parent
+ * @param parent this <code>ServiceManager</code>'s parent
*/
public DefaultServiceManager( final ServiceManager parent )
{
@@ -48,10 +48,10 @@
}
/**
- * Retrieve Object by role from ServiceManager.
+ * Retrieve <code>Object</code> by role from <code>ServiceManager</code>.
*
* @param role the role
- * @return the Object
+ * @return the <code>Object</code>
* @throws ServiceException if an error occurs
*/
public Object lookup( final String role )
@@ -96,9 +96,9 @@
}
/**
- * Place Object into ComponentManager.
+ * Place <code>Object</code> into <code>ServiceManager</code>.
*
- * @param role the components role
+ * @param role the object's role
* @param object an <code>Object</code> value
*/
public void put( final String role, final Object object )
@@ -108,9 +108,10 @@
}
/**
- * Build a human readable representation of the ServiceManager.
+ * Build a human readable representation of this
+ * <code>ServiceManager</code>.
*
- * @return the description of the ServiceManager
+ * @return the description of this <code>ServiceManager</code>
*/
public String toString()
{
@@ -131,7 +132,7 @@
/**
* Helper method for subclasses to retrieve parent.
*
- * @return the parent ServiceManager
+ * @return the parent <code>ServiceManager</code>
*/
protected final ServiceManager getParent()
{
@@ -149,7 +150,7 @@
}
/**
- * Makes this service manager read-only.
+ * Makes this <code>ServiceManager</code> read-only.
*
*/
public void makeReadOnly()
@@ -158,9 +159,10 @@
}
/**
- * Checks if this service manager is writeable.
+ * Checks if this <code>ServiceManager</code> is writeable.
*
- * @throws IllegalStateException if this service manager is read-only
+ * @throws IllegalStateException if this <code>ServiceManager</code> is
+ * read-only
*/
protected final void checkWriteable()
throws IllegalStateException
@@ -173,7 +175,7 @@
}
/**
- * Release the object.
+ * Release the <code>Object</code>.
* @param object The <code>Object</code> to release.
*/
public void release( Object object ){}
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
