mpoeschl 2002/11/19 09:35:11
Modified: src/java/org/apache/torque/om ComboKey.java
Log:
add javadocs describing the toString format
Revision Changes Path
1.10 +13 -2
jakarta-turbine-torque/src/java/org/apache/torque/om/ComboKey.java
Index: ComboKey.java
===================================================================
RCS file:
/home/cvs/jakarta-turbine-torque/src/java/org/apache/torque/om/ComboKey.java,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- ComboKey.java 19 Nov 2002 16:34:09 -0000 1.9
+++ ComboKey.java 19 Nov 2002 17:35:11 -0000 1.10
@@ -112,6 +112,8 @@
/**
* Sets the internal representation to a String array.
+ *
+ * @see toString()
*/
public ComboKey(String keys)
{
@@ -291,6 +293,11 @@
return isEqual;
}
+ /**
+ *
+ * @param sb
+ * @see toString()
+ */
public void appendTo(StringBuffer sb)
{
if (key != null)
@@ -350,7 +357,11 @@
/**
* A String that may consist of one section or multiple sections
- * separated by a colon.
+ * separated by a colon. <br/>
+ * Each Key is represented by <code>[type N|S|D][value][:]</code>. <p/>
+ * Example: <br/>
+ * the ComboKey(StringKey("key1"), NumberKey(2)) is represented as
+ * <code><b>Skey1:N2:</b></code>
*/
public String toString()
{
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
