Update of /var/cvs/src/org/mmbase/bridge
In directory james.mmbase.org:/tmp/cvs-serv8736/src/org/mmbase/bridge
Modified Files:
Node.java Transaction.java Query.java Cloud.java
BridgeList.java CloudContext.java
Log Message:
Added some javadoc
See also: http://cvs.mmbase.org/viewcvs/src/org/mmbase/bridge
Index: Node.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/Node.java,v
retrieving revision 1.75
retrieving revision 1.76
diff -u -b -r1.75 -r1.76
--- Node.java 3 Feb 2008 17:33:57 -0000 1.75
+++ Node.java 16 Feb 2008 22:13:53 -0000 1.76
@@ -21,7 +21,7 @@
*
* @author Rob Vermeulen
* @author Pierre van Rooden
- * @version $Id: Node.java,v 1.75 2008/02/03 17:33:57 nklasens Exp $
+ * @version $Id: Node.java,v 1.76 2008/02/16 22:13:53 nklasens Exp $
*/
public interface Node extends Comparable<Node> {
@@ -193,6 +193,9 @@
/**
* Sets the value of the specified field using a
<code>java.io.InputStream</code>.
+ * @param fieldName the name of the field to be updated
+ * @param value the new value for the given field
+ * @param size size of input stream
* @since MMBase-1.8.
*/
public void setInputStreamValue(String fieldName, InputStream value, long
size);
@@ -242,8 +245,10 @@
public void setListValue(String fieldName, List value);
/**
- * Whether the value for the speficied field is <code>null</code>. This
avoids acquiring the
- * complete value if you only want to check if for emptyness.
+ * Whether the value for the specified field is <code>null</code>. This
avoids acquiring the
+ * complete value if you only want to check if for emptiness.
+ * @param fieldName the name of the field
+ * @return <code>true</code> when value is <code>null</code>
* @since MMBase-1.8
*/
public boolean isNull(String fieldName);
@@ -252,6 +257,8 @@
/**
* Returns the 'size' (e.g. the number of bytes of a byte array) for the
specified field. This
* avoids acquiring the complete value if you only want to know how big
the value of the field is.
+ * @param fieldName the name of the field
+ * @return the 'size'
* @since MMBase-1.8
*/
public long getSize(String fieldName);
@@ -282,6 +289,7 @@
* You can use this to get data from a field for validation purposes.
*
* @param fieldName name of field
+ * @return value without processing
* @since MMBase-1.8
*/
public Object getValueWithoutProcess(String fieldName);
@@ -400,8 +408,10 @@
/**
* Returns the value of the specified field as a
<code>java.io.InputStream</code> This is
- * especially usefull for large byte-array fields. By this you can avoid
them to be completely
+ * especially useful for large byte-array fields. By this you can avoid
them to be completely
* stored in memory.
+ * @param fieldName the name of the field
+ * @return value of field as a input stream
* @since MMBase-1.8
*/
public InputStream getInputStreamValue(String fieldName);
@@ -494,25 +504,30 @@
public void delete();
/**
- * Whether this Node is new (not yet commited).
+ * Whether this Node is new (not yet committed).
+ * @return <code>true</code> when new
* @since MMBase-1.8
*/
public boolean isNew();
/**
* Whether a certain field's value was changed since the last commit.
+ * @param fieldName the name of the field
+ * @return <code>true</code> when field's value was changed
* @since MMBase-1.8
*/
public boolean isChanged(String fieldName);
/**
* A Set of Strings containing the names of all changed fields.
+ * @return Set of changed fields
* @since MMBase-1.8
*/
public Set<String> getChanged();
/**
* Whether field values were changed since the last commit.
+ * @return <code>true</code> when changed
* @since MMBase-1.8
*/
public boolean isChanged();
Index: Transaction.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/Transaction.java,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -b -r1.5 -r1.6
--- Transaction.java 19 Jun 2006 14:16:21 -0000 1.5
+++ Transaction.java 16 Feb 2008 22:13:53 -0000 1.6
@@ -20,7 +20,7 @@
* back by calling the transaction's cancel method.
*
* @author Pierre van Rooden
- * @version $Id: Transaction.java,v 1.5 2006/06/19 14:16:21 nklasens Exp $
+ * @version $Id: Transaction.java,v 1.6 2008/02/16 22:13:53 nklasens Exp $
*/
public interface Transaction extends Cloud {
@@ -44,11 +44,15 @@
public void cancel();
/**
+ * Returns whether the transaction is committed
+ * @return <code>true</code> when committed
* @since MMBase-1.8
*/
public boolean isCommitted();
/**
+ * Returns whether the transaction is canceled
+ * @return <code>true</code> when canceled
* @since MMBase-1.8
*/
public boolean isCanceled();
Index: Query.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/Query.java,v
retrieving revision 1.44
retrieving revision 1.45
diff -u -b -r1.44 -r1.45
--- Query.java 20 Apr 2007 12:18:37 -0000 1.44
+++ Query.java 16 Feb 2008 22:13:53 -0000 1.45
@@ -19,7 +19,7 @@
*
* @author Michiel Meeuwissen
* @author Pierre van Rooden
- * @version $Id: Query.java,v 1.44 2007/04/20 12:18:37 pierre Exp $
+ * @version $Id: Query.java,v 1.45 2008/02/16 22:13:53 nklasens Exp $
* @since MMBase-1.7
* @see org.mmbase.bridge.util.Queries
*/
@@ -304,6 +304,7 @@
* Adds an order on a certain field.
* @param f field
* @param direction [EMAIL PROTECTED] SortOrder#ORDER_ASCENDING} or [EMAIL
PROTECTED] SortOrder#ORDER_DESCENDING}
+ * @param caseSensitive case sensitivity
* @param part part to sort on for a date value
* @return new SortOrder
* @see
org.mmbase.storage.search.implementation.BasicSearchQuery#addSortOrder
@@ -313,6 +314,10 @@
/**
* Defaulting version of [EMAIL PROTECTED] #addSortOrder(StepField, int,
boolean, int)} (no date parts)
+ * @param f field
+ * @param direction [EMAIL PROTECTED] SortOrder#ORDER_ASCENDING} or [EMAIL
PROTECTED] SortOrder#ORDER_DESCENDING}
+ * @param caseSensitive case sensitivity
+ * @return new SortOrder
* @since MMBase-1.8
*/
SortOrder addSortOrder(StepField f, int direction, boolean caseSensitive);
@@ -320,6 +325,9 @@
/**
* Defaulting version of [EMAIL PROTECTED] #addSortOrder(StepField, int,
boolean, int)} (sorting case
* insensitively, and no date parts).
+ * @param f field
+ * @param direction [EMAIL PROTECTED] SortOrder#ORDER_ASCENDING} or
[EMAIL PROTECTED] SortOrder#ORDER_DESCENDING}
+ * @return new SortOrder
*/
SortOrder addSortOrder(StepField f, int direction);
@@ -331,6 +339,8 @@
void addNode(Step s, Node node);
/**
+ * @param s query step
+ * @param number node number
* @since MMBase-1.8
*/
void addNode(Step s, int number);
@@ -370,6 +380,7 @@
/**
* Executes the query and returns the resulting node list.
+ * @return resulting node list
* @since MMBase-1.8
*/
NodeList getList();
@@ -378,6 +389,7 @@
* Shows the query in a human-readable SQL form. This is probably not the
query which will
* actually be sent to the database. This method is provided because
'toString' on a Query object
* is pretty complete, but pretty undigestable for mere mortals too.
+ * @return human-readable SQL
*
* @since MMBase-1.8
*/
Index: Cloud.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/Cloud.java,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -b -r1.64 -r1.65
--- Cloud.java 22 Jan 2008 16:44:47 -0000 1.64
+++ Cloud.java 16 Feb 2008 22:13:53 -0000 1.65
@@ -21,7 +21,7 @@
* @author Rob Vermeulen
* @author Pierre van Rooden
* @author Jaco de Groot
- * @version $Id: Cloud.java,v 1.64 2008/01/22 16:44:47 michiel Exp $
+ * @version $Id: Cloud.java,v 1.65 2008/02/16 22:13:53 nklasens Exp $
*/
public interface Cloud {
@@ -152,6 +152,10 @@
public boolean mayRead(int number);
/**
+ * Check whether an action is allowed
+ * @param action Action to perform
+ * @param parameters parameters passed into this action
+ * @return <code>true</code> when allowed
* @since MMBase-1.9
*/
public boolean may(org.mmbase.security.Action action,
org.mmbase.util.functions.Parameters parameters);
@@ -593,6 +597,7 @@
/**
* Retrieves all properties previously set for this cloud.
+ * @return all properties
* @since MMBase-1.8
*/
public Map<Object, Object> getProperties();
@@ -617,10 +622,11 @@
*
* @since MMBase-1.8
* @param setName name of the function set
+ * @param functionName name of the function
* @return a [EMAIL PROTECTED] org.mmbase.util.functions.Function} object.
* @throws NotFoundException if the function set or the function do not
exist
*/
- public Function getFunction(String setName, String functionName);
+ public Function<?> getFunction(String setName, String functionName);
/**
* Returns a new, empty node list for this cloud
Index: BridgeList.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/BridgeList.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -b -r1.9 -r1.10
--- BridgeList.java 16 Feb 2007 20:03:24 -0000 1.9
+++ BridgeList.java 16 Feb 2008 22:13:53 -0000 1.10
@@ -17,7 +17,8 @@
* A list of nodes
*
* @author Pierre van Rooden
- * @version $Id: BridgeList.java,v 1.9 2007/02/16 20:03:24 michiel Exp $
+ * @version $Id: BridgeList.java,v 1.10 2008/02/16 22:13:53 nklasens Exp $
+ * @param <E> Type of elements
* @since MMBase-1.6
*/
public interface BridgeList<E> extends List<E> {
Index: CloudContext.java
===================================================================
RCS file: /var/cvs/src/org/mmbase/bridge/CloudContext.java,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -b -r1.32 -r1.33
--- CloudContext.java 16 Nov 2007 16:07:15 -0000 1.32
+++ CloudContext.java 16 Feb 2008 22:13:53 -0000 1.33
@@ -19,7 +19,7 @@
* @author Rob Vermeulen
* @author Pierre van Rooden
* @author Jaco de Groot
- * @version $Id: CloudContext.java,v 1.32 2007/11/16 16:07:15 michiel Exp $
+ * @version $Id: CloudContext.java,v 1.33 2008/02/16 22:13:53 nklasens Exp $
*/
public interface CloudContext {
@@ -76,6 +76,7 @@
* @param name The name of the cloud to be returned, always
"mmbase".
* @param user The user object for which this cloud object
must be created.
* @return the requested cloud
+ * @throws NotFoundException thrown when cloud not found
* @since MMBase-1.8
*/
public Cloud getCloud(String name, org.mmbase.security.UserContext user)
throws NotFoundException;
@@ -108,6 +109,7 @@
/**
* Returns the default time zone.
+ * @return the default time zone
* @since MMBase-1.8
*/
public java.util.TimeZone getDefaultTimeZone();
@@ -175,21 +177,28 @@
/**
* Acquired information about the currently configuration Authentication
implementation.
+ * @return current Authentication information
* @since MMBase-1.8
*/
public AuthenticationData getAuthentication();
/**
+ * Returns the Repository with actions
+ * @return Repository with actions
* @since MMBase-1.9
*/
public ActionRepository getActionRepository();
/**
+ * Returns whether MMbase is up and running
+ * @return <code>true</code> when mmbase is running
* @since MMBase-1.8
*/
public boolean isUp();
+
/**
+ * Assert whether MMbase is up and running. This will wait until it is.
* @since MMBase-1.8
*/
public void assertUp();
_______________________________________________
Cvs mailing list
[email protected]
http://lists.mmbase.org/mailman/listinfo/cvs
