Update of /var/cvs/src/org/mmbase/framework
In directory james.mmbase.org:/tmp/cvs-serv17652/src/org/mmbase/framework
Modified Files:
Framework.java StringRenderer.java Component.java
ChainedRenderer.java
Log Message:
Fixes un javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/framework
Index: Framework.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Framework.java,v
retrieving revision 1.49
retrieving revision 1.50
diff -u -b -r1.49 -r1.50
--- Framework.java 22 Mar 2008 09:12:59 -0000 1.49
+++ Framework.java 25 Mar 2008 21:00:24 -0000 1.50
@@ -21,13 +21,13 @@
/**
* A framework displays and processes components.
*
- * The Framework as UrlConverter must never return <code>null</code>, iow, it
should
+ * The Framework as UrlConverter must never return <code>null</code>, IOW, it
should
* <em>always</em> know how to do this.
*
*
* @author Johannes Verelst
* @author Pierre van Rooden
- * @version $Id: Framework.java,v 1.49 2008/03/22 09:12:59 michiel Exp $
+ * @version $Id: Framework.java,v 1.50 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public abstract class Framework {
@@ -99,7 +99,7 @@
/**
* A framework must be able to provide a node to the rendered blocks. This
parameter could
* indicate _which_ node.
- * @todo Not yet suported, so basic framework cannot yet support block
which require a framework
+ * @todo Not yet supported, so basic framework cannot yet support block
which require a framework
* provided node.
*/
public static final Parameter<Node> N = new Parameter<Node>("n",
Node.class);
@@ -107,12 +107,15 @@
/**
* Return the name of the framework
+ * @return Name
*/
public abstract String getName();
/**
* Returns the block which is specified by framework parameters.
+ * @param frameworkParameters framework parameters
+ * @return Block
*/
public abstract Block getBlock(Parameters frameworkParameters);
@@ -123,7 +126,7 @@
* Return a Parameters object that needs to be passed on to the getUrl()
call.
*
* Many components will be implemented as servlets, so will not work if
the framework does not
- * at least include [EMAIL PROTECTED] Parameter.REQUEST} and [EMAIL
PROTECTED] Parameter.RESPONSE}. So it is
+ * at least include [EMAIL PROTECTED] Parameter#REQUEST} and [EMAIL
PROTECTED] Parameter#RESPONSE}. So it is
* recommended that those parameters are supported by the framework.
*
*
@@ -134,6 +137,7 @@
* A framework may create a different or expanded list of parameters, but
is responsible for filling them properly.
* If the framework does not use the MMBase taglib for rendering of
components, it needs to provide it's own mechanism to
* fill the above parameters with default values (such as through a
servlet or portlet).
+ * @return Parameters
*/
public abstract Parameters createParameters();
@@ -142,7 +146,7 @@
* The framework decides on a (extra) class for the div which is to be
rendered, which is put on
* the request as [EMAIL PROTECTED] #COMPONENT_CLASS_KEY}.
*
- * @param renderer the Renderer used to produce the content. This
parameter is obtained using [EMAIL PROTECTED] Block#getRenderer()}
+ * @param renderer the Renderer used to produce the content. This
parameter is obtained using [EMAIL PROTECTED]
Block#getRenderer(org.mmbase.framework.Renderer.Type)}
* @param blockParameters The parameters specific for the call of this
renderer's block
* @param frameworkParameters The parameters that are required by the
framework, such as the 'request' and 'cloud' objects
* @param w The writer where the code generated by the renderer is to be
written (such as the jspWriter)
@@ -164,9 +168,10 @@
/**
* Return an MMBase Node for the user currently using the framework. It is
recommended that this
- * is implemented as is done in [EMAIL PROTECTED] BasicFramework}, so
based on MMBase security only, and
- * using a [EMAIL PROTECTED] Parameter.CLOUD} as a framework parameter. It
can be implemented differently,
+ * is implemented as is done in [EMAIL PROTECTED]
org.mmbase.framework.basic.BasicFramework}, so based on MMBase security only,
and
+ * using a [EMAIL PROTECTED] Parameter#CLOUD} as a framework parameter. It
can be implemented differently,
* if the framework chooses not to use MMBase security to distinguish
between users.
+ * @param frameworkParameters The parameters that are required by the
framework, such as the 'request' and 'cloud' objects.
*/
public abstract Node getUserNode(Parameters frameworkParameters);
;
@@ -174,7 +179,7 @@
/**
* Return the builder name that is used to store users. This will return
the name of the nodemanager that returns
* the nodes from the getUserNode() method.
- * @TODO What if the framework wants to return virtual nodes?
+ * @todo What if the framework wants to return virtual nodes?
* @throws UnsupportedOperationException
*/
public abstract String getUserBuilder();
@@ -192,7 +197,7 @@
* always associated with a certain [EMAIL PROTECTED] Component}.
*
* The framework can (and should) return the default values of the Setting
if it does not know
- * what to do. It can also adminstrate overridden values, e.g. in its own
configuration file.
+ * what to do. It can also administrate overridden values, e.g. in its own
configuration file.
* Using the 'parameters' (created with [EMAIL PROTECTED]
#createSettingValueParameters}, the Framework can also
* implement context specific values for a setting. It can e.g. use a
request object, and store
@@ -201,7 +206,7 @@
public abstract <C> C getSettingValue(Setting<C> setting, Parameters
parameters);
/**
- * See [EMAIL PROTECTED] #getSettingValue}. Depending on the framework,
the set value may not necessarily be persistant.
+ * See [EMAIL PROTECTED] #getSettingValue}. Depending on the framework,
the set value may not necessarily be persistent.
*
* @throws SecurityException If you are not allowed to change the setting.
*/
@@ -226,7 +231,8 @@
* @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.
withouth a context path),
+ * @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
*/
public abstract String getUrl(String path,
Map<String, Object> parameters,
@@ -250,8 +256,9 @@
* @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 interal URL, or <code>null</code> if nothing framework
specific could be
+ * @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
*/
public abstract String getInternalUrl(String path,
Map<String, Object> params,
Index: StringRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/StringRenderer.java,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -b -r1.10 -r1.11
--- StringRenderer.java 20 Feb 2008 17:44:07 -0000 1.10
+++ StringRenderer.java 25 Mar 2008 21:00:24 -0000 1.11
@@ -19,10 +19,10 @@
/**
* The overly simple renderer which is simply based on a String present in the
configuration
- * file. Based on [EMAIL PROTECTED] PatterNodeFunctionProvider} so several
parameters can be present.
+ * file. Based on [EMAIL PROTECTED] PatternNodeFunctionProvider} so several
parameters can be present.
*
* @author Michiel Meeuwissen
- * @version $Id: StringRenderer.java,v 1.10 2008/02/20 17:44:07 michiel Exp $
+ * @version $Id: StringRenderer.java,v 1.11 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public class StringRenderer extends AbstractRenderer {
Index: Component.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/Component.java,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -b -r1.19 -r1.20
--- Component.java 22 Feb 2008 14:05:57 -0000 1.19
+++ Component.java 25 Mar 2008 21:00:24 -0000 1.20
@@ -16,10 +16,10 @@
* A component is a piece of pluggable functionality that typically has
dependencies on other
* components.
*
- * A Component bundles [EMAIL PROTECTED] Block}s, [EMAIL PROTECTED] Action}s
and [EMAIL PROTECTED] @Setting}.
+ * A Component bundles [EMAIL PROTECTED] Block}s, [EMAIL PROTECTED] Action}s
and [EMAIL PROTECTED] Setting}.
*
* @author Michiel Meeuwissen
- * @version $Id: Component.java,v 1.19 2008/02/22 14:05:57 michiel Exp $
+ * @version $Id: Component.java,v 1.20 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public interface Component {
Index: ChainedRenderer.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/framework/ChainedRenderer.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -b -r1.4 -r1.5
--- ChainedRenderer.java 3 Feb 2008 17:33:56 -0000 1.4
+++ ChainedRenderer.java 25 Mar 2008 21:00:24 -0000 1.5
@@ -12,21 +12,18 @@
import java.util.*;
import java.io.*;
import org.mmbase.util.functions.*;
-import org.mmbase.util.logging.Logger;
-import org.mmbase.util.logging.Logging;
/**
- * This renderer simply calles the methods of a number of other Renderes
sequentially. Only
- * [EMAIL PROTECTED] Renderer.Type.HEAD} renderers can be chained, because
they don't have to produce a well defined
+ * This renderer simply calls the methods of a number of other Renderers
sequentially. Only
+ * [EMAIL PROTECTED] Renderer.Type#HEAD} renderers can be chained, because
they don't have to produce a well defined
* block.
*
* @author Michiel Meeuwissen
- * @version $Id: ChainedRenderer.java,v 1.4 2008/02/03 17:33:56 nklasens Exp $
+ * @version $Id: ChainedRenderer.java,v 1.5 2008/03/25 21:00:24 nklasens Exp $
* @since MMBase-1.9
*/
public class ChainedRenderer extends AbstractRenderer {
- private static final Logger log =
Logging.getLoggerInstance(ChainedRenderer.class);
protected final List<Renderer> chain = new ArrayList<Renderer>();
protected Parameter[] parameters = Parameter.EMPTY;
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
