From: cvs@openprivacy.orgCVS update: talon/src/java/talon
Date: Thursday March 1, 19101 @ 14:42
Author: burton
CVSWEB Options: -------------------
Main CVSWeb: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi
View this module: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon
-----------------------------------
Update of /usr/local/cvs/public/talon/src/java/talon
In directory giga:/tmp/cvs-serv16375/src/java/talon
Modified Files:
Component.java ComponentHandle.java
Log Message:
updated javadoc to reflect correct use of initialization properties
*****************************************************************
File: talon/src/java/talon/Component.java
CVSWEB Options: -------------------
CVSWeb: Annotate this file: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/Component.java?annotate=1.5
CVSWeb: View this file: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/Component.java?rev=1.5&content-type=text/x-cvsweb-markup
CVSWeb: Diff to previous version: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/Component.java.diff?r1=1.5&r2=1.4
-----------------------------------
Index: talon/src/java/talon/Component.java
diff -u talon/src/java/talon/Component.java:1.4 talon/src/java/talon/Component.java:1.5
--- talon/src/java/talon/Component.java:1.4 Sat Feb 24 21:31:19 2001
+++ talon/src/java/talon/Component.java Thu Mar 1 14:42:45 2001
@@ -14,13 +14,14 @@
import talon.interfaces.*;
import talon.util.net.*;
-//import talon.implementations.*;
/**
+ * Any object that wants to act as a Component with Talon must implement this
+ * interface. This contains all necessary methods for an object to participate
+ * as a first class Component with the system.
*
- *
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public interface Component {
@@ -29,16 +30,16 @@
* Called when this object is initialized.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public void init() throws TalonException;
/**
- * Get the handle for this component.
+ * Get the handle for this component.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle getComponentHandle();
@@ -59,7 +60,7 @@
*
* @see Object#hashCode
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public URI getComponentReference();
@@ -67,15 +68,17 @@
* Set the handle for this component.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public void setComponentHandle( ComponentHandle handle );
/**
- * Get the Talon default log stream for this component.
+ * Get the Talon default log stream for this component. Any logging your
+ * component has to do should use this method. This allows Components to
+ * switch logging implementations without needing a specific configuration.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: Component.java,v 1.4 2001/02/25 05:31:19 burton Exp $
+ * @version $Id: Component.java,v 1.5 2001/03/01 22:42:45 burton Exp $
*/
public Logger getLogger();
*****************************************************************
File: talon/src/java/talon/ComponentHandle.java
CVSWEB Options: -------------------
CVSWeb: Annotate this file: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/ComponentHandle.java?annotate=1.10
CVSWeb: View this file: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/ComponentHandle.java?rev=1.10&content-type=text/x-cvsweb-markup
CVSWeb: Diff to previous version: http://openprivacy.org/cgi-bin/cvsweb/cvsweb.cgi/talon/src/java/talon/ComponentHandle.java.diff?r1=1.10&r2=1.9
-----------------------------------
Index: talon/src/java/talon/ComponentHandle.java
diff -u talon/src/java/talon/ComponentHandle.java:1.9 talon/src/java/talon/ComponentHandle.java:1.10
--- talon/src/java/talon/ComponentHandle.java:1.9 Fri Feb 23 02:09:17 2001
+++ talon/src/java/talon/ComponentHandle.java Thu Mar 1 14:42:45 2001
@@ -18,7 +18,7 @@
* Object which is used to find components within the system.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public class ComponentHandle {
@@ -55,7 +55,7 @@
* Create a basic ComponentHandle
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle() {}
@@ -64,7 +64,7 @@
* pulled from the Talon properties.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle( String _interface ) {
@@ -76,7 +76,7 @@
* The interface and classname.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle( String _interface,
String _implementation ) {
@@ -91,7 +91,7 @@
* The interface and classname. You may specify a PropertyManager here.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle( String _interface,
String _classname,
@@ -106,7 +106,7 @@
* Also set the name.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle( String name,
String _interface,
@@ -170,7 +170,7 @@
/**
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public String getLifetime() {
return this._lifetime;
@@ -180,7 +180,7 @@
/**
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle setLifetime( String _lifetime ) {
this._lifetime = _lifetime;
@@ -189,7 +189,7 @@
/**
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public String getDescription() {
return this._description;
@@ -197,7 +197,7 @@
/**
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public ComponentHandle setDescription( String _description ) {
this._description = _description;
@@ -205,14 +205,21 @@
}
/**
- * @see Component
+ * Maintains a set of properties that can be passed to a component during
+ * initialization.
+ *
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public PropertyManager getInitProperties() {
return this.initProperties;
}
+ /**
+ * @see #getInitProperties
+ * @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
+ */
public ComponentHandle setInitProperties( PropertyManager initProperties ) {
this.initProperties = initProperties;
return this;
@@ -222,7 +229,7 @@
* Dump Handle information..
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public String toString() {
return this.getName() + ":" + this.getInterface() + " -> " + this.getImplementation();
@@ -232,7 +239,7 @@
* Return a cloned ComponentHandle.
*
* @author <a href="mailto:burton@relativity.yi.org">Kevin A. Burton</a>
- * @version $Id: ComponentHandle.java,v 1.9 2001/02/23 10:09:17 burton Exp $
+ * @version $Id: ComponentHandle.java,v 1.10 2001/03/01 22:42:45 burton Exp $
*/
public Object clone() {
This archive was generated by hypermail 2b30 : Thu Mar 01 2001 - 14:43:16 PST