[jbpm-pvm] JBoss JBPM SVN: r1520 - in api/trunk/modules/api: src/main/java/org/jboss/bpm and 2 other directories.

[<do-...@jb...>]

Author: tho...@jb...
Date: 2008-07-04 09:26:28 -0400 (Fri, 04 Jul 2008)
New Revision: 1520

Modified:
   api/trunk/modules/api/pom.xml
   api/trunk/modules/api/src/main/java/org/jboss/bpm/Context.java
   api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ExecutionFactory.java
   api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessDefinitionManager.java
   api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessEngine.java
   api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessInstanceFactory.java
   api/trunk/modules/api/src/main/java/org/jboss/bpm/runtime/Transition.java
Log:
javadoc

Modified: api/trunk/modules/api/pom.xml
===================================================================
--- api/trunk/modules/api/pom.xml	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/pom.xml	2008-07-04 13:26:28 UTC (rev 1520)
@@ -56,7 +56,7 @@
         <artifactId>maven-javadoc-plugin</artifactId>
         <configuration>
           <show>public</show>
-          <excludePackageNames>*.internal</excludePackageNames>
+          <excludePackageNames>*.internal:*.incubation:*.test</excludePackageNames>
         </configuration>
       </plugin>
     </plugins>

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/Context.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/Context.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/Context.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -33,6 +33,11 @@
  */
 public abstract class Context
 {
+  // Hide public constructor
+  protected Context()
+  {
+  }
+
   /** Get arbitrary attachments */
   public abstract Collection<Key> getAttachments();
 

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ExecutionFactory.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ExecutionFactory.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ExecutionFactory.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -38,6 +38,11 @@
   // Injected through the MC
   protected ProcessEngine engine;
 
+  // Hide public constructor
+  protected ExecutionFactory()
+  {
+  }
+
   /**
    * Get the associated process engine
    */

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessDefinitionManager.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessDefinitionManager.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessDefinitionManager.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -40,12 +40,16 @@
  */
 public abstract class ProcessDefinitionManager
 {
-
   // Injected through the MC
   protected ProcessEngine engine;
   // The set of process definitions
   private Set<ProcessDefinition> pdefs = new HashSet<ProcessDefinition>();
 
+  // Hide public constructor
+  protected ProcessDefinitionManager()
+  {
+  }
+
   /*  Get the associated process engine */
   public ProcessEngine getProcessEngine()
   {

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessEngine.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessEngine.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessEngine.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -45,16 +45,31 @@
   // Flag to indicate that the Engine is shutting down
   private boolean prepareForShutdown;
 
+  // Hide public constructor
+  protected ProcessEngine()
+  {
+  }
+  
+  /**
+   * Prepare the engine for shutdown.
+   * During shutdown the creation of new processes is disallowed.
+   */
   public void prepareForShutdown()
   {
     prepareForShutdown = true;
   }
   
+  /**
+   * True, if engine is preparing for shutdown.
+   */
   public boolean isPrepareForShutdown()
   {
     return prepareForShutdown;
   }
   
+  /**
+   * Cancel the prepare for shutdown request
+   */
   public void cancelShutdown()
   {
     prepareForShutdown = false;

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessInstanceFactory.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessInstanceFactory.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/client/ProcessInstanceFactory.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -35,10 +35,14 @@
  */
 public abstract class ProcessInstanceFactory
 {
-
   // Injected through the MC
   protected ProcessEngine engine;
 
+  // Hide public constructor
+  protected ProcessInstanceFactory()
+  {
+  }
+  
   /* Get the associated process engine */
   public ProcessEngine getProcessEngine()
   {

Modified: api/trunk/modules/api/src/main/java/org/jboss/bpm/runtime/Transition.java
===================================================================
--- api/trunk/modules/api/src/main/java/org/jboss/bpm/runtime/Transition.java	2008-07-04 12:58:42 UTC (rev 1519)
+++ api/trunk/modules/api/src/main/java/org/jboss/bpm/runtime/Transition.java	2008-07-04 13:26:28 UTC (rev 1520)
@@ -31,6 +31,11 @@
  */
 public abstract class Transition
 {
+  // Hide public constructor
+  protected Transition()
+  {
+  }
+  
   /**
    * Get the name for this transition
    */