From 27f15fd9c583f88e22642f2248641475aa9fcee8 Mon Sep 17 00:00:00 2001
From: James Strachan <jstrachan@apache.org>
Date: Wed, 18 Oct 2006 10:52:34 +0000
Subject: [PATCH] added better javadoc comments to add better descriptions on
 the XSD reference

git-svn-id: https://svn.apache.org/repos/asf/incubator/activemq/trunk@465204 13f79535-47bb-0310-9956-ffa450edef68
---
 .../DefaultPersistenceAdapterFactory.java     | 24 +++++++++++++++++++
 .../store/jdbc/JDBCPersistenceAdapter.java    |  9 +++++++
 2 files changed, 33 insertions(+)

diff --git a/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java b/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java
index fe1ad24c2c..62246f4a4a 100755
--- a/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java
+++ b/activemq-core/src/main/java/org/apache/activemq/store/DefaultPersistenceAdapterFactory.java
@@ -75,6 +75,9 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return journalLogFiles;
     }
 
+    /**
+     * Sets the number of journal log files to use
+     */
     public void setJournalLogFiles(int journalLogFiles) {
         this.journalLogFiles = journalLogFiles;
     }
@@ -84,6 +87,8 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
     }
 
     /**
+     * Sets the size of the journal log files
+     *
      * @org.apache.xbean.Property propertyEditor="org.apache.activemq.util.MemoryIntPropertyEditor"
      */
     public void setJournalLogFileSize(int journalLogFileSize) {
@@ -102,6 +107,11 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return useJournal;
     }
 
+    /**
+     * Enables or disables the use of the journal. The default is to use the journal
+     *
+     * @param useJournal
+     */
     public void setUseJournal(boolean useJournal) {
         this.useJournal = useJournal;
     }
@@ -144,6 +154,11 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return useQuickJournal;
     }
 
+    /**
+     * Enables or disables the use of quick journal, which keeps messages in the journal and just
+     * stores a reference to the messages in JDBC. Defaults to false so that messages actually reside
+     * long term in the JDBC database.
+     */
     public void setUseQuickJournal(boolean useQuickJournal) {
         this.useQuickJournal = useQuickJournal;
     }
@@ -167,6 +182,9 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return jdbcPersistenceAdapter.isUseDatabaseLock();
     }
 
+    /**
+     * Sets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
+     */
     public void setUseDatabaseLock(boolean useDatabaseLock) {
         jdbcPersistenceAdapter.setUseDatabaseLock(useDatabaseLock);
     }
@@ -175,6 +193,9 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return jdbcPersistenceAdapter.isCreateTablesOnStartup();
     }
 
+    /**
+     * Sets whether or not tables are created on startup
+     */
     public void setCreateTablesOnStartup(boolean createTablesOnStartup) {
         jdbcPersistenceAdapter.setCreateTablesOnStartup(createTablesOnStartup);
     }
@@ -183,6 +204,9 @@ public class DefaultPersistenceAdapterFactory extends DataSourceSupport implemen
         return journalThreadPriority;
     }
 
+    /**
+     * Sets the thread priority of the journal thread
+     */
     public void setJournalThreadPriority(int journalThreadPriority){
         this.journalThreadPriority=journalThreadPriority;
     }
diff --git a/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java b/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java
index a701f32972..fbb50355f6 100755
--- a/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java
+++ b/activemq-core/src/main/java/org/apache/activemq/store/jdbc/JDBCPersistenceAdapter.java
@@ -372,6 +372,9 @@ public class JDBCPersistenceAdapter extends DataSourceSupport implements Persist
         return cleanupPeriod;
     }
 
+    /**
+     * Sets the number of milliseconds until the database is attempted to be cleaned up for durable topics
+     */
     public void setCleanupPeriod(int cleanupPeriod) {
         this.cleanupPeriod = cleanupPeriod;
     }
@@ -402,6 +405,9 @@ public class JDBCPersistenceAdapter extends DataSourceSupport implements Persist
         return createTablesOnStartup;
     }
 
+    /**
+     * Sets whether or not tables are created on startup
+     */
     public void setCreateTablesOnStartup(boolean createTablesOnStartup) {
         this.createTablesOnStartup = createTablesOnStartup;
     }
@@ -410,6 +416,9 @@ public class JDBCPersistenceAdapter extends DataSourceSupport implements Persist
         return useDatabaseLock;
     }
 
+    /**
+     * Sets whether or not an exclusive database lock should be used to enable JDBC Master/Slave. Enabled by default.
+     */
     public void setUseDatabaseLock(boolean useDatabaseLock) {
         this.useDatabaseLock = useDatabaseLock;
     }