[CVS spice] Javadoc updates
sjoberg-yCVjj/[email protected] 20 Oct 2005 16:22:48 -0000
| Newsgroups | gmane.comp.java.spice.cvs |
|---|---|
| Message-ID | <[email protected]> |
<html>
<head>
<style><!--
body {background-color:#ffffff;}
.file {border:1px solid #eeeeee;margin-top:1em;margin-bottom:1em;}
.pathname {font-family:monospace; float:right;}
.fileheader {margin-bottom:.5em;}
.diff {margin:0;}
.tasklist {padding:4px;border:1px dashed #000000;margin-top:1em;}
.tasklist ul {margin-top:0;margin-bottom:0;}
tr.alt {background-color:#eeeeee}
#added {background-color:#ddffdd;}
#addedchars {background-color:#99ff99;font-weight:bolder;}
tr.alt #added {background-color:#ccf7cc;}
#removed {background-color:#ffdddd;}
#removedchars {background-color:#ff9999;font-weight:bolder;}
tr.alt #removed {background-color:#f7cccc;}
#info {color:#888888;}
#context {background-color:#eeeeee;}
td {padding-left:.3em;padding-right:.3em;}
tr.head {border-bottom-width:1px;border-bottom-style:solid;}
tr.head td {padding:0;padding-top:.2em;}
.task {background-color:#ffff00;}
.comment {padding:4px;border:1px dashed #000000;background-color:#ffffdd}
.error {color:red;}
hr {border-width:0px;height:2px;background:black;}
--></style>
</head>
<body>
<table cellspacing="0" cellpadding="0" border="0" rules="cols">
<tr class="head"><td colspan="4">Commit in <b><tt>spice/components/jervlet/src/java/org/codehaus/spice/jervlet</tt></b><span id="info"> on MAIN</span></td></tr>
<tr><td><tt><a href="#file1">Container.java</a></tt></td><td align="right" id="added">+6</td><td align="right" id="removed">-6</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr class="alt"><td><tt><a href="#file2">Context.java</a></tt></td><td align="right" id="added">+9</td><td align="right" id="removed">-6</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr><td><tt><a href="#file3">ContextHandler.java</a></tt></td><td align="right" id="added">+5</td><td align="right" id="removed">-5</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr class="alt"><td><tt><a href="#file4">Instantiator.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr><td><tt><a href="#file5">Listener.java</a></tt></td><td align="right" id="added">+1</td><td align="right" id="removed">-1</td><td nowrap="nowrap" align="center">1.3 -> 1.4</td></tr>
<tr class="alt"><td><tt><a href="#file6">ListenerHandler.java</a></tt></td><td align="right" id="added">+3</td><td align="right" id="removed">-3</td><td nowrap="nowrap" align="center">1.1 -> 1.2</td></tr>
<tr><td><tt><a href="#file7">ListenerMonitor.java</a></tt></td><td align="right" id="added">+4</td><td align="right" id="removed">-4</td><td nowrap="nowrap" align="center">1.2 -> 1.3</td></tr>
<tr><td></td><td align="right" id="added">+29</td><td align="right" id="removed">-26</td><td></td></tr>
</table>
<small id="info">7 modified files</small><br />
<pre class="comment">
Javadoc updates
</pre>
<hr /><a name="file1" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>Container.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- Container.java 5 Jul 2005 18:37:42 -0000 1.2
+++ Container.java 20 Oct 2005 16:22:48 -0000 1.3
@@ -11,14 +11,14 @@
</small></pre><pre class="diff" id="context"> * The <code>Container</code> interface represents a servlet container.
* In Jervlet the container has only two functions, to create and
* destroy <code>ContextHandler</code>s. The context handlers are used
</pre><pre class="diff" id="removed">- * to manage contexts.
</pre><pre class="diff" id="added">+ * to manage <code>Context</code>s.
</pre><pre class="diff" id="context"> * <br/><br/>
</pre><pre class="diff" id="removed">- * The idea behind this interface is to shield web applications from other
- * components in the system, using the same container (read web server). A
- * context can only be managed through the <code>ContextManager</code>
- * that created it.
</pre><pre class="diff" id="added">+ * The idea behind this interface, or functionality, is to shield web
+ * applications from other components using the same container
+ * (read web server). A context can only be managed through the
+ * <code>ContextManager</code> that created it.
</pre><pre class="diff" id="context"> * <br/><br/>
</pre><pre class="diff" id="removed">- * A container implementation representing a HTTP server/servlet container
</pre><pre class="diff" id="added">+ * A container implementation representing a<span id="addedchars">n</span> HTTP server/servlet container
</pre><pre class="diff" id="context"> * would normally implement the <code>Container</code> and
* <code>ListenerHandler</code> interfaces. In a system where all
* components can access all contexts noting says that the container
</pre></div>
<hr /><a name="file2" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>Context.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- Context.java 5 Jul 2005 18:37:42 -0000 1.2
+++ Context.java 20 Oct 2005 16:22:48 -0000 1.3
@@ -13,6 +13,9 @@
</small></pre><pre class="diff" id="context"> * The <code>Context</code> interface represents a web context. A web
* context holds information about a web application. This includes
* e.g. the path, possible virtual hosts and a pointer to the resource.
</pre><pre class="diff" id="added">+ * In Jervlet, contexts also hold a reference to an
+ * <code>Instantiator</code>. The instantiator is used to create new
+ * instances of servlets or servlet filters.
</pre><pre class="diff" id="context"> *
* @author Johan Sjoberg
* @author Peter Royal
</pre><pre class="diff"><small id="info">@@ -31,10 +34,10 @@
</small></pre><pre class="diff" id="context">
/**
* Fetch possible virtual hosts defined for this context. As
</pre><pre class="diff" id="removed">- * virtual hosts are optional for web contexts the returned list
- * can be empty.
</pre><pre class="diff" id="added">+ * virtual hosts are optional for web contexts the returned
+ * array can be empty or null.
</pre><pre class="diff" id="context"> *
</pre><pre class="diff" id="removed">- * @return A new list of the virtual hosts for this context.
</pre><pre class="diff" id="added">+ * @return An array of virtual hosts for this context, or null.
</pre><pre class="diff" id="context"> */
String[] getVirtualHosts();
</pre><pre class="diff"><small id="info">@@ -48,15 +51,15 @@
</small></pre><pre class="diff" id="context"> URL getResource();
/**
</pre><pre class="diff" id="removed">- * If the resource is a W<span id="removedchars">eb Archiv</span>e, should it be extracted?
</pre><pre class="diff" id="added">+ * If the resource is a W<span id="addedchars">AR fil</span>e, should it be extracted?
</pre><pre class="diff" id="context"> *
</pre><pre class="diff" id="removed">- * @return true if the <span id="removedchars">C</span>ontainer should extract the resource, else false
</pre><pre class="diff" id="added">+ * @return true if the <span id="addedchars">c</span>ontainer should extract the resource, else false
</pre><pre class="diff" id="context"> */
boolean extractWebArchive();
/**
* Fetch the <code>Instantiator</code> that should be used to instantiate
</pre><pre class="diff" id="removed">- * the servlet classes in this context.
</pre><pre class="diff" id="added">+ * the servlet <span id="addedchars">and filter </span>classes in this context.
</pre><pre class="diff" id="context"> *
* @return A reference to this context's instantiator implementation.
*/
</pre></div>
<hr /><a name="file3" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>ContextHandler.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- ContextHandler.java 5 Jul 2005 18:37:42 -0000 1.2
+++ ContextHandler.java 20 Oct 2005 16:22:48 -0000 1.3
@@ -53,16 +53,16 @@
</small></pre><pre class="diff" id="context"> void stopContext( Context context ) throws ContextException;
/**
</pre><pre class="diff" id="removed">- * List the <code>Context</code>s that this <code>ContextHandler</code>
- * can manage.
</pre><pre class="diff" id="added">+ * List the <code>Context</code>s this <code>ContextHandler</code>
+ * manages.
</pre><pre class="diff" id="context"> *
</pre><pre class="diff" id="removed">- * @return A new list of contexts holding all JervletContexts
</pre><pre class="diff" id="added">+ * @return A new list of Contexts
</pre><pre class="diff" id="context"> */
List getContexts();
/**
</pre><pre class="diff" id="removed">- * Check if <code>Context</context> owned by this handler
- * is started on not.
</pre><pre class="diff" id="added">+ * Check if a <code>Context</code> is started on not. The given
+ * context must be managed by the asked context handler.
</pre><pre class="diff" id="context"> *
* @param context The context to check
* @return true if the given context is started, else false
</pre></div>
<hr /><a name="file4" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>Instantiator.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- Instantiator.java 5 Jul 2005 18:37:42 -0000 1.2
+++ Instantiator.java 20 Oct 2005 16:22:48 -0000 1.3
@@ -26,7 +26,7 @@
</small></pre><pre class="diff" id="context"> /**
* Instantiate a servlet or filter class.
*
</pre><pre class="diff" id="removed">- * @param clazz The servlet o<span id="removedchars">f</span> filter class to instantiate
</pre><pre class="diff" id="added">+ * @param clazz The servlet o<span id="addedchars">r</span> filter class to instantiate
</pre><pre class="diff" id="context"> * @return The instatiated class
* @throws InstantiationException
* @throws IllegalAccessException
</pre></div>
<hr /><a name="file5" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>Listener.java</b></big> <small id="info">1.3 -> 1.4</small></div>
<pre class="diff"><small id="info">diff -u -r1.3 -r1.4
--- Listener.java 20 Oct 2005 15:07:24 -0000 1.3
+++ Listener.java 20 Oct 2005 16:22:48 -0000 1.4
@@ -47,7 +47,7 @@
</small></pre><pre class="diff" id="context"> /**
* Fetch the connection type.
*
</pre><pre class="diff" id="removed">- * @return The type id <span id="removedchars">i</span>f this connection.
</pre><pre class="diff" id="added">+ * @return The type id <span id="addedchars">o</span>f this connection.
</pre><pre class="diff" id="context"> */
int getType();
}
</pre></div>
<hr /><a name="file6" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>ListenerHandler.java</b></big> <small id="info">1.1 -> 1.2</small></div>
<pre class="diff"><small id="info">diff -u -r1.1 -r1.2
--- ListenerHandler.java 5 Jul 2005 13:32:12 -0000 1.1
+++ ListenerHandler.java 20 Oct 2005 16:22:48 -0000 1.2
@@ -42,14 +42,14 @@
</small></pre><pre class="diff" id="context">
/**
* Fetch a list of all current <code>Listener</code>s. If there are
</pre><pre class="diff" id="removed">- * no listener the returned list can be empty.
</pre><pre class="diff" id="added">+ * no listeners the returned list can be empty, but not null.
</pre><pre class="diff" id="context"> *
</pre><pre class="diff" id="removed">- * @return All <span id="removedchars">new list all </span>current listeners.
</pre><pre class="diff" id="added">+ * @return All current listeners.
</pre><pre class="diff" id="context"> */
List getListeners();
/**
</pre><pre class="diff" id="removed">- * Check if a <code>Listener</code> is started<span id="removedchars"> or not</span>.
</pre><pre class="diff" id="added">+ * Check if a <code>Listener</code> is started.
</pre><pre class="diff" id="context"> *
* @param listener The listener
* @return True if the listener is started, else false.
</pre></div>
<hr /><a name="file7" /><div class="file">
<span class="pathname">spice/components/jervlet/src/java/org/codehaus/spice/jervlet<br /></span>
<div class="fileheader"><big><b>ListenerMonitor.java</b></big> <small id="info">1.2 -> 1.3</small></div>
<pre class="diff"><small id="info">diff -u -r1.2 -r1.3
--- ListenerMonitor.java 5 Jul 2005 18:37:42 -0000 1.2
+++ ListenerMonitor.java 20 Oct 2005 16:22:48 -0000 1.3
@@ -62,7 +62,7 @@
</small></pre><pre class="diff" id="context"> void removeListenerWarning( Class reportingClass, Listener listener, String message );
/**
</pre><pre class="diff" id="removed">- * Report that a listener <span id="removedchars">has been</span> added
</pre><pre class="diff" id="added">+ * Report that a listener <span id="addedchars">was</span> added
</pre><pre class="diff" id="context"> *
* @param reportingClass The class reporting the listener start event
* @param listener The listener that was started
</pre><pre class="diff"><small id="info">@@ -70,7 +70,7 @@
</small></pre><pre class="diff" id="context"> void addListenerNotification( Class reportingClass, Listener listener );
/**
</pre><pre class="diff" id="removed">- * Report that a listner <span id="removedchars">has been</span> removed
</pre><pre class="diff" id="added">+ * Report that a listner <span id="addedchars">was</span> removed
</pre><pre class="diff" id="context"> *
* @param reportingClass The class reporting the listener stop event
* @param listener The listener that was stopped
</pre><pre class="diff"><small id="info">@@ -120,7 +120,7 @@
</small></pre><pre class="diff" id="context"> void stopListenerWarning( Class reportingClass, Listener listener, String message );
/**
</pre><pre class="diff" id="removed">- * Report that a listener <span id="removedchars">has been</span> started
</pre><pre class="diff" id="added">+ * Report that a listener <span id="addedchars">was</span> started
</pre><pre class="diff" id="context"> *
* @param reportingClass The class reporting the listener start event
* @param listener The listener that was started
</pre><pre class="diff"><small id="info">@@ -128,7 +128,7 @@
</small></pre><pre class="diff" id="context"> void startListenerNotification( Class reportingClass, Listener listener );
/**
</pre><pre class="diff" id="removed">- * Report that a listner <span id="removedchars">has been</span> stopped
</pre><pre class="diff" id="added">+ * Report that a listner <span id="addedchars">was</span> stopped
</pre><pre class="diff" id="context"> *
* @param reportingClass The class reporting the listener stop event
* @param listener The listener that was stopped
</pre></div>
<center><small><a href="http://www.badgers-in-foil.co.uk/projects/cvsspam/" title="commit -> email">CVSspam</a> 0.2.8</small></center>
</body></html>