You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by rd...@apache.org on 2003/08/16 08:28:42 UTC
cvs commit: jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/strategy ObjectStringConverter.java
rdonkin 2003/08/15 23:28:42
Modified: betwixt/src/java/org/apache/commons/betwixt/strategy
ObjectStringConverter.java
Log:
Improved java docs
Revision Changes Path
1.2 +17 -5 jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/strategy/ObjectStringConverter.java
Index: ObjectStringConverter.java
===================================================================
RCS file: /home/cvs/jakarta-commons/betwixt/src/java/org/apache/commons/betwixt/strategy/ObjectStringConverter.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ObjectStringConverter.java 31 Jul 2003 21:37:25 -0000 1.1
+++ ObjectStringConverter.java 16 Aug 2003 06:28:42 -0000 1.2
@@ -66,7 +66,19 @@
import org.apache.commons.betwixt.expression.Context;
/**
- * Strategy class allows custom string <-> object conversion implementations.
+ * <p>Strategy class for string <-> object conversions.
+ * Implementations of this interface are used by Betwixt to perform
+ * string <-> object conversions.
+ * This performs only the most basic conversions.
+ * Most applications will use a subclass.
+ * </p>
+ * <p>It is strongly recommended that (in order to support round tripping)
+ * that <code>objectToString</code> and <code>stringToObject</code>
+ * are inverse functions.
+ * In other words, given the same flavour, context and type the applying
+ * objectToString to the result of stringToObject should be equal to the
+ * original input.
+ * </p>
*/
public class ObjectStringConverter implements Serializable {
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org