dlr 01/06/03 17:48:25
Modified: src/java/org/apache/turbine/om BaseObject.java
Log:
* Added JavaDoc.
* Renamed private constant more appropriately and corrected its
positioning within the file.
Revision Changes Path
1.28 +19 -7 jakarta-turbine/src/java/org/apache/turbine/om/BaseObject.java
Index: BaseObject.java
===================================================================
RCS file: /home/cvs/jakarta-turbine/src/java/org/apache/turbine/om/BaseObject.java,v
retrieving revision 1.27
retrieving revision 1.28
diff -u -r1.27 -r1.28
--- BaseObject.java 2001/05/23 18:52:33 1.27
+++ BaseObject.java 2001/06/04 00:48:24 1.28
@@ -63,13 +63,23 @@
*
* @author <a href="mailto:[EMAIL PROTECTED]";>Frank Y. Kim</a>
* @author <a href="mailto:[EMAIL PROTECTED]";>John D. McNally</a>
- * @version $Id: BaseObject.java,v 1.27 2001/05/23 18:52:33 mikeh Exp $
+ * @version $Id: BaseObject.java,v 1.28 2001/06/04 00:48:24 dlr Exp $
*/
public abstract class BaseObject implements Persistent, Serializable
{
+ /**
+ * The constant denoting an unset numeric database identifier.
+ */
public static final int NEW_ID = -1;
/**
+ * Shared portion of the error message thrown for methods which
+ * are not implemented.
+ */
+ private static final String NOT_IMPLEMENTED =
+ "Not implemented: Method must be overridden if called";
+
+ /**
* attribute to determine if this object has previously been saved.
*/
private boolean is_new = true;
@@ -300,13 +310,15 @@
}
/**
- * Saves the object. Must be overridden if called.
+ * Saves this object to the data store. Not implemented by
+ * default, so must be overridden if called.
+ *
+ * @exception Exception Problem saving this object.
*/
- private static String errMsg = "method must be overridden if called";
public void save()
throws Exception
{
- throw new Error("BaseObject.save: " + errMsg);
+ throw new Error("BaseObject.save: " + NOT_IMPLEMENTED);
}
/**
@@ -319,7 +331,7 @@
*/
public Object getByName(String field)
{
- throw new Error("BaseObject.getByName: " + errMsg);
+ throw new Error("BaseObject.getByName: " + NOT_IMPLEMENTED);
}
/**
@@ -329,7 +341,7 @@
*/
public Object getByPeerName(String name)
{
- throw new Error("BaseObject.getByPeerName: " + errMsg);
+ throw new Error("BaseObject.getByPeerName: " + NOT_IMPLEMENTED);
}
/**
@@ -339,7 +351,7 @@
*/
public Object getByPosition(int pos)
{
- throw new Error("BaseObject.getByPosition: " + errMsg);
+ throw new Error("BaseObject.getByPosition: " + NOT_IMPLEMENTED);
}
/**
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
