You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by cz...@apache.org on 2001/11/16 16:13:03 UTC
cvs commit: jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source Source.java SourceResolver.java SourceResolverImpl.java
cziegeler 01/11/16 07:13:03
Modified: src/scratchpad/org/apache/avalon/excalibur/source
Source.java SourceResolver.java
SourceResolverImpl.java
Log:
Added some javadocs
Revision Changes Path
1.4 +4 -7 jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/Source.java
Index: Source.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/Source.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- Source.java 2001/11/14 15:58:03 1.3
+++ Source.java 2001/11/16 15:13:03 1.4
@@ -13,14 +13,12 @@
/**
* Description of a source. This interface provides a simple interface
- * for accessing a source of data. The source of data is assumed to
- * <b>not change</b> during the lifetime of the Source object. If you
- * have a data source that can change its content and you want it to
- * reflect, use a {@link ModifiableSource} object instead.
+ * for accessing a source of data. But this data can only be accessed once
+ * using this object! You can only read data from it more than once
+ * if it is a {@link ReusableSource}.
*
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
- * @author <a href="mailto:ovidiu@cup.hp.com">Ovidiu Predescu</a>
- * @version CVS $Revision: 1.3 $ $Date: 2001/11/14 15:58:03 $
+ * @version CVS $Revision: 1.4 $ $Date: 2001/11/16 15:13:03 $
*/
public interface Source {
@@ -47,7 +45,6 @@
* content.
*
* @return an <code>InputSource</code> value
- * @exception ProcessingException if an error occurs
* @exception IOException if an error occurs
*/
InputSource getInputSource()
1.5 +12 -1 jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceResolver.java
Index: SourceResolver.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceResolver.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- SourceResolver.java 2001/11/14 15:58:03 1.4
+++ SourceResolver.java 2001/11/16 15:13:03 1.5
@@ -15,9 +15,20 @@
/**
* Base interface for resolving a source by system identifiers.
+ * Instead of using the java.net.URL classes which prevent you
+ * to add your own custom protocols in a server environment,
+ * you should use this resolver for all URLs.
*
+ * The resolver creates for each source a <code>Source</code>
+ * object, which could then be asked for an <code>InputStream</code>
+ * etc.
+ *
+ * When the <code>Source</code> object is no longer needed
+ * it must be release using the resolver. This is very similar like
+ * looking up components from a <code>ComponentManager</code>.
+ *
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
- * @version CVS $Revision: 1.4 $ $Date: 2001/11/14 15:58:03 $
+ * @version CVS $Revision: 1.5 $ $Date: 2001/11/16 15:13:03 $
*/
public interface SourceResolver
1.7 +22 -2 jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceResolverImpl.java
Index: SourceResolverImpl.java
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/src/scratchpad/org/apache/avalon/excalibur/source/SourceResolverImpl.java,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- SourceResolverImpl.java 2001/11/16 14:55:08 1.6
+++ SourceResolverImpl.java 2001/11/16 15:13:03 1.7
@@ -29,13 +29,33 @@
import java.net.MalformedURLException;
import java.net.URL;
+
/**
+ * Base interface for resolving a source by system identifiers.
+ * Instead of using the java.net.URL classes which prevent you
+ * to add your own custom protocols in a server environment,
+ * you should use this resolver for all URLs.
+ *
+ * The resolver creates for each source a <code>Source</code>
+ * object, which could then be asked for an <code>InputStream</code>
+ * etc.
+ *
+ * When the <code>Source</code> object is no longer needed
+ * it must be release using the resolver. This is very similar like
+ * looking up components from a <code>ComponentManager</code>.
+ *
* @author <a href="mailto:cziegeler@apache.org">Carsten Ziegeler</a>
- * @version $Id: SourceResolverImpl.java,v 1.6 2001/11/16 14:55:08 cziegeler Exp $
+ * @version $Id: SourceResolverImpl.java,v 1.7 2001/11/16 15:13:03 cziegeler Exp $
*/
public class SourceResolverImpl
extends AbstractLoggable
-implements ThreadSafe, Configurable, Disposable, Composable, Contextualizable, SourceResolver {
+implements Composable,
+ Configurable,
+ Contextualizable,
+ Disposable,
+ SourceResolver,
+ ThreadSafe
+{
/** The component manager */
protected ComponentManager manager;
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>