Update of /var/cvs/src/org/mmbase/framework/basic
In directory james.mmbase.org:/tmp/cvs-serv17652/src/org/mmbase/framework/basic
Modified Files:
UrlConverter.java BasicUrlConverter.java State.java
Log Message:
Fixes un javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/framework/basic
Index: UrlConverter.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/basic/UrlConverter.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- UrlConverter.java 22 Feb 2008 14:05:57 -0000 1.5
+++ UrlConverter.java 25 Mar 2008 21:00:24 -0000 1.6
@@ -16,14 +16,14 @@
/**
* Responsible for the proper handling of urls within the basic framework
[EMAIL PROTECTED] BasicFramework}.
* You should implement UrlConverter if you want to create and resolve your own
- * userfriendly links within [EMAIL PROTECTED] BasicFramework}
+ * user-friendly links within [EMAIL PROTECTED] BasicFramework}
*.
* You can configure several UrlConverters in 'framework.xml'.
*
* They will be chained one after another.
* @author Michiel Meeuwissen
- * @version $Id: UrlConverter.java,v 1.5 2008/02/22 14:05:57 michiel Exp $
+ * @version $Id: UrlConverter.java,v 1.6 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public interface UrlConverter {
@@ -32,8 +32,16 @@
Parameter[] getParameterDefinition();
/**
- * See [EMAIL PROTECTED] Framework#getUrl(String, Map, Parameters,
boolean)}.
+ * See [EMAIL PROTECTED] org.mmbase.framework.Framework#getUrl(String,
Map, Parameters, boolean)}.
* But it can also return <code>null</code> which mean, 'I don't know.'
+ * @param path The path (generally a relative URL) to create an URL for.
+ * @param parameters Parameters The parameters to be passed to the page
+ * @param frameworkParameters The parameters that are required by the
framework
+ * @param escapeAmps <code>true</code> if parameters should be added with
an escaped & (&amp;).
+ * You should escape & when a URL is exposed (i.e.
in HTML), but not if the url is
+ * for some reason called directly.
+ * @return An URL relative to the root of this web application (i.e.
without a context path),
+ * @throws FrameworkException thrown when something goes wrong in the
Framework
*/
String getUrl(String path,
Map<String, Object> parameters,
@@ -48,8 +56,15 @@
/**
- * See [EMAIL PROTECTED] Framework#geInternaltUrl(String, Map,
Parameters)}.
+ * See [EMAIL PROTECTED]
org.mmbase.framework.Framework#getInternalUrl(String, Map, Parameters)}.
* But it can also return <code>null</code> which mean, 'I don't know'.
+ * @param path The page (e.g. image/css) provided by the component to
create an URL for
+ * @param params Extra parameters for that path
+ * @param frameworkParameters The parameters that are required by the
framework, such as the
+ * 'request' and 'cloud' objects
+ * @return A valid internal URL, or <code>null</code> if nothing framework
specific could be
+ * determined (this would make it possible to 'chain' frameworks).
+ * @throws FrameworkException thrown when something goes wrong in the
Framework
*/
String getInternalUrl(String path,
Map<String, Object> params,
Index: BasicUrlConverter.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/basic/BasicUrlConverter.java,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -b -r1.13 -r1.14
--- BasicUrlConverter.java 25 Mar 2008 09:20:24 -0000 1.13
+++ BasicUrlConverter.java 25 Mar 2008 21:00:24 -0000 1.14
@@ -26,7 +26,7 @@
*
*
* @author Michiel Meeuwissen
- * @version $Id: BasicUrlConverter.java,v 1.13 2008/03/25 09:20:24 michiel Exp
$
+ * @version $Id: BasicUrlConverter.java,v 1.14 2008/03/25 21:00:24 nklasens
Exp $
* @since MMBase-1.9
*/
public final class BasicUrlConverter implements UrlConverter {
@@ -40,9 +40,10 @@
*
* @param page servletPath
* @param params The query to be added
- * @param req A request object is needed to determin context-paths and so
on.
- * @param writeamp Wether amperstands must be XML-escaped. Typically
needed if the URL is used
+ * @param req A request object is needed to determine context-paths and so
on.
+ * @param escapeamp Whether ampersands must be XML-escaped. Typically
needed if the URL is used
* in (X)HTML.
+ * @return An URL relative to the root of this web application (i.e.
without a context path),
*/
public static String getUrl(String page, Map<String, Object> params,
HttpServletRequest req, boolean escapeamp) {
if (log.isDebugEnabled()) {
@@ -112,7 +113,7 @@
}
/**
- * @todo Actually these paremters are only added here, because this
urlconverter is always in
+ * @todo Actually these parameters are only added here, because this
urlconverter is always in
* BasicFramework. Actually BasicFramework should add them itself.
*/
public Parameter[] getParameterDefinition() {
Index: State.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/basic/State.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- State.java 21 Mar 2008 10:39:23 -0000 1.5
+++ State.java 25 Mar 2008 21:00:24 -0000 1.6
@@ -25,7 +25,7 @@
*
*
* @author Michiel Meeuwissen
- * @version $Id: State.java,v 1.5 2008/03/21 10:39:23 michiel Exp $
+ * @version $Id: State.java,v 1.6 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public class State {
@@ -185,10 +185,10 @@
/**
* @return Whether action must be performed.
- * @renderer Proposed renderer (State may decide to render another one,
and return that)
+ * @param frameworkParameters The parameters that are required by the
framework
+ * @param renderer Proposed renderer (State may decide to render another
one, and return that)
* @throws IllegalStateException When renderers which should occur 'later'
were already rendered,
* or when the belonging request was already 'ended'.
-
*/
public Renderer startBlock(Parameters frameworkParameters, Renderer
renderer) {
if (count == 0) {
@@ -208,8 +208,7 @@
}
/**
- * Determins what should be rendered now.
- * @param block a proposal
+ * Determines what should be rendered now.
*/
protected Renderer getRenderer(Renderer r) {
String blockName = request.getParameter("__b" + getId());
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
