Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / general / src / main / java / org / wamblee / persistence / Persistent.java
index 5962d5f340500543d1071031d6f9fa41380755d1..b832daa676d458997a70ffaef84e2c87de4b9ced 100644 (file)
@@ -17,48 +17,49 @@ package org.wamblee.persistence;
 
 import java.io.Serializable;
 
-
 /**
- * Interface for persistent objects. This defines required functionality for all objects
- * that are persisted.
- *
+ * Interface for persistent objects. This defines required functionality for all
+ * objects that are persisted.
+ * 
  * Objects that implement this interface and which implement
- * {@link java.lang.Object#equals(java.lang.Object)}
- * should exclude the primary key and version from determining equality.
+ * {@link java.lang.Object#equals(java.lang.Object)} should exclude the primary
+ * key and version from determining equality.
  */
 public interface Persistent {
     /**
      * Gets the primary key.
-     *
+     * 
      * @return Primary key.
-     *
+     * 
      * @see #setPrimaryKey(Serializable)
      */
     Serializable getPrimaryKey();
 
     /**
      * Sets the primary key.
-     *
-     * @param aKey Primary key.
-     *
+     * 
+     * @param aKey
+     *            Primary key.
+     * 
      * @see #getPrimaryKey()
      */
     void setPrimaryKey(Serializable aKey);
 
     /**
      * Gets the version.
-     *
+     * 
      * @return Version.
-     *
+     * 
      * @see #setPersistedVersion(int)
      */
     int getPersistedVersion();
 
     /**
      * Sets the version.
-     *
-     * @param aVersion Version.
-     *
+     * 
+     * @param aVersion
+     *            Version.
+     * 
      * @see #getPersistedVersion()
      */
     void setPersistedVersion(int aVersion);