Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / general / src / main / java / org / wamblee / persistence / Persistent.java
index 57faf95e16694de8a9827d6763670e225e2f9c24..b832daa676d458997a70ffaef84e2c87de4b9ced 100644 (file)
@@ -1,58 +1,66 @@
 /*
  * Copyright 2005 the original author or authors.
- * 
+ *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- */ 
-
+ */
 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. 
+ * 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.
  */
 public interface Persistent {
-
     /**
-     * Gets the primary key. 
+     * Gets the primary key.
+     * 
      * @return Primary key.
-     * @see #setPrimaryKey(Serializable) 
+     * 
+     * @see #setPrimaryKey(Serializable)
      */
-    Serializable getPrimaryKey(); 
-    
+    Serializable getPrimaryKey();
+
     /**
-     * Sets the primary key. 
-     * @param aKey Primary key.
-     * @see #getPrimaryKey() 
+     * Sets the primary key.
+     * 
+     * @param aKey
+     *            Primary key.
+     * 
+     * @see #getPrimaryKey()
      */
-    void setPrimaryKey(Serializable aKey); 
-    
+    void setPrimaryKey(Serializable aKey);
+
     /**
-     * Gets the version. 
-     * @return Version. 
+     * Gets the version.
+     * 
+     * @return Version.
+     * 
      * @see #setPersistedVersion(int)
      */
-    int getPersistedVersion(); 
-    
+    int getPersistedVersion();
+
     /**
-     * Sets the version. 
-     * @param aVersion Version. 
+     * Sets the version.
+     * 
+     * @param aVersion
+     *            Version.
+     * 
      * @see #getPersistedVersion()
      */
-    void setPersistedVersion(int aVersion); 
+    void setPersistedVersion(int aVersion);
 }