Merge pull request #1159 from Marketcetera/MATP-1172

MATP-1172 Update and complete Javadoc

admin/admin-api/src/main/java/org/marketcetera/admin/AdminClient.java

@@ -49,6 +49,7 @@ public interface AdminClient
      *
      * @param inNewUser a <code>User</code> value
      * @param inPassword a <code>String</code> value
+     * @return a <code>User</code> value
      */
     User createUser(User inNewUser,
                     String inPassword);
@@ -128,7 +129,7 @@ Permission updatePermission(String inPermissionName,
     /**
      * Read roles.
      *
-     * @return a <code>List&lt;Role&gt</code> value
+     * @return a <code>List&lt;Role&gt;</code> value
      */
     List<Role> readRoles();
     /**

admin/admin-api/src/main/java/org/marketcetera/admin/MutableUserAttributeFactory.java

@@ -17,7 +17,7 @@ public interface MutableUserAttributeFactory
      *
      * @param inUser a <code>User</code> value
      * @param inType a <code>UserAttributeType</code> value
-     * @param inAttribute a <code>String<code> value
+     * @param inAttribute a <code>String</code> value
      * @return a <code>UserAttribute</code> value
      */
     MutableUserAttribute create(User inUser,

admin/admin-api/src/main/java/org/marketcetera/admin/UserAttributeFactory.java

@@ -16,7 +16,7 @@ public interface UserAttributeFactory
      *
      * @param inUser a <code>User</code> value
      * @param inType a <code>UserAttributeType</code> value
-     * @param inAttribute a <code>String<code> value
+     * @param inAttribute a <code>String</code> value
      * @return a <code>UserAttribute</code> value
      */
     UserAttribute create(User inUser,

admin/admin-api/src/main/java/org/marketcetera/admin/service/PasswordService.java

@@ -21,7 +21,7 @@ public interface PasswordService
     /**
      * Get the hash of the given value.
      *
-     * @param inValue a <code>char[][]</code> value
+     * @param inValues a <code>char[][]</code> value
      * @return a <code>String</code> value
      */
     String getHash(char[]...inValues);

admin/admin-rpc-core/src/test/java/org/marketcetera/admin/rpc/AdminRpcUtilTest.java

@@ -106,7 +106,7 @@ public void testGetRpcRole()
                       rpcRole);
     }
     /**
-     * Test {@link AdminRpcUtil#getRole(com.marketcetera.admin.AdminRpc.Role, RoleFactory)}.
+     * Test <code>getRole</code>.
      *
      * @throws Exception if an unexpected error occurs
      */
@@ -170,7 +170,7 @@ public void testGetRpcPermission()
                             rpcPermission);
     }
     /**
-     * Test {@link AdminRpcUtil#getUserAttribute(com.marketcetera.admin.AdminRpc.UserAttribute)}.
+     * Test <code>getUserAttribute</code>.
      *
      * @throws Exception if an unexpected error occurs
      */

admin/admin-server/src/main/java/org/marketcetera/admin/AddUserToRoleAction.java

@@ -18,6 +18,9 @@
  */
 public class AddUserToRoleAction
 {
+    /**
+     * Validate and start the object.
+     */
     @PostConstruct
     public void start()
     {
@@ -56,7 +59,7 @@ public String getUsername()
     /**
      * Sets the username value.
      *
-     * @param a <code>String</code> value
+     * @param inUsername a <code>String</code> value
      */
     public void setUsername(String inUsername)
     {
@@ -74,18 +77,18 @@ public String getRoleName()
     /**
      * Sets the roleName value.
      *
-     * @param a <code>String</code> value
+     * @param inRoleName a <code>String</code> value
      */
     public void setRoleName(String inRoleName)
     {
         roleName = inRoleName;
     }
     /**
-     * 
+     * username value
      */
     private String username;
     /**
-     * 
+     * role name value
      */
     private String roleName;
     /**

admin/admin-server/src/main/java/org/marketcetera/admin/AddUserToSupervisorRoleAction.java

@@ -18,6 +18,9 @@
  */
 public class AddUserToSupervisorRoleAction
 {
+    /**
+     * Validate and start the object.
+     */
     @PostConstruct
     public void start()
     {
@@ -56,7 +59,7 @@ public String getSubjectUsername()
     /**
      * Sets the subjectUsername value.
      *
-     * @param a <code>String</code> value
+     * @param inSubjectUsername a <code>String</code> value
      */
     public void setSubjectUsername(String inSubjectUsername)
     {
@@ -74,18 +77,18 @@ public String getSupervisorPermissionName()
     /**
      * Sets the supervisorPermissionName value.
      *
-     * @param a <code>String</code> value
+     * @param inSupervisorPermissionName a <code>String</code> value
      */
     public void setSupervisorPermissionName(String inSupervisorPermissionName)
     {
         supervisorPermissionName = inSupervisorPermissionName;
     }
     /**
-     * 
+     * subject username value 
      */
     private String subjectUsername;
     /**
-     * 
+     * supervisor username value
      */
     private String supervisorPermissionName;
     /**

admin/admin-server/src/main/java/org/marketcetera/admin/provisioning/ProvisioningAgent.java

@@ -111,7 +111,7 @@ public long getPollingInterval()
     /**
      * Sets the pollingInterval value.
      *
-     * @param a <code>long</code> value
+     * @param inPollingInterval a <code>long</code> value
      */
     public void setPollingInterval(long inPollingInterval)
     {
@@ -129,7 +129,7 @@ public String getProvisioningDirectory()
     /**
      * Sets the provisioningDirectory value.
      *
-     * @param a <code>String</code> value
+     * @param inProvisioningDirectory a <code>String</code> value
      */
     public void setProvisioningDirectory(String inProvisioningDirectory)
     {
@@ -147,7 +147,7 @@ public ClusterService getClusterService()
     /**
      * Sets the clusterService value.
      *
-     * @param a <code>ClusterService</code> value
+     * @param inClusterService a <code>ClusterService</code> value
      */
     public void setClusterService(ClusterService inClusterService)
     {

admin/admin-server/src/main/java/org/marketcetera/admin/user/PersistentUser.java

@@ -194,9 +194,6 @@ public void setPassword(char[] password)
      * {@link #validatePassword(char[]) validating} the supplied password.
      * @param originalPassword the original password. This password should
      * match the currently configured password.
-     * <p>
-     * The new password is not saved to the database. To save
-     * the new password to the database, invoke {@link #save()}
      *
      * @param newPassword the new password, cannot be empty.
      *

cluster/cluster-api/src/main/java/org/marketcetera/cluster/service/ClusterService.java

@@ -111,7 +111,7 @@ void setAttribute(String inKey,
     /**
      * Get the attribute with the given key for the local cluster member.
      *
-     * @param inKey a <code>String<code> value
+     * @param inKey a <code>String</code> value
      * @return a <code>String</code> value or <code>null</code>
      */
     String getAttribute(String inKey);
@@ -125,7 +125,7 @@ void setAttribute(String inKey,
     /**
      * Get the attributes for all cluster members.
      *
-     * @return a <code>Map&lt;String,Map&l;String,String&gt;&gt;</code> value
+     * @return a <code>Map&lt;String,Map&lt;String,String&gt;&gt;</code> value
      */
     Map<String,Map<String,String>> getAttributes();
     /**

cluster/cluster-core/src/main/java/org/marketcetera/cluster/SimpleClusterWorkUnitSpec.java

@@ -104,7 +104,7 @@ public String getWorkUnitUid()
     /**
      * Sets the workUnitUid value.
      *
-     * @param a <code>String</code> value
+     * @param inWorkUnitUid a <code>String</code> value
      */
     public void setWorkUnitUid(String inWorkUnitUid)
     {

cluster/cluster-core/src/main/java/org/marketcetera/cluster/service/AbstractClusterService.java

@@ -649,8 +649,6 @@ protected Set<ClusterWorkUnitDescriptor> getActiveWorkUnitSpecs(ClusterWorkUnitS
     }
     /**
      * Establishes the set of work unit specs for the cluster.
-     *
-     * @throws InterruptedException if the appropriate cluster lock cannot be established
      */
     protected void establishWorkUnitSpecs()
     {

core/src/main/java/org/marketcetera/algo/BrokerAlgoTagSpec.java

@@ -187,7 +187,7 @@ public String getDefaultValue()
     /**
      * Sets the defaultValue value.
      *
-     * @param a <code>String</code> value
+     * @param inDefaultValue a <code>String</code> value
      */
     public void setDefaultValue(String inDefaultValue)
     {
@@ -205,7 +205,7 @@ public boolean isReadOnly()
     /**
      * Sets the isReadOnly value.
      *
-     * @param a <code>boolean</code> value
+     * @param inIsReadOnly a <code>boolean</code> value
      */
     public void setIsReadOnly(boolean inIsReadOnly)
     {
@@ -223,7 +223,7 @@ public String getAdvice()
     /**
      * Sets the advice value.
      *
-     * @param a <code>String</code> value
+     * @param inAdvice a <code>String</code> value
      */
     public void setAdvice(String inAdvice)
     {

core/src/main/java/org/marketcetera/core/ApplicationContextProvider.java

@@ -28,7 +28,7 @@ public ApplicationContext getApplicationContext()
     /**
      * Sets the applicationContext value.
      *
-     * @param an <code>ApplicationContext</code> value
+     * @param inApplicationContext an <code>ApplicationContext</code> value
      */
     public void setApplicationContext(ApplicationContext inApplicationContext)
     {

core/src/main/java/org/marketcetera/core/BaseClientContextualParameters.java

@@ -26,7 +26,7 @@ public ContextClassProvider getContextClassProvider()
     /**
      * Sets the contextClassProvider value.
      *
-     * @param a <code>ContextClassProvider</code> value
+     * @param inContextClassProvider a <code>ContextClassProvider</code> value
      */
     public void setContextClassProvider(ContextClassProvider inContextClassProvider)
     {

core/src/main/java/org/marketcetera/core/BatchQueueProcessor.java

@@ -38,7 +38,7 @@ public BatchQueueProcessor(String inThreadDescription)
     /**
      * Create a new BatchQueueProcessor instance.
      *
-     * @param inThreadDescription a <code>String</code> value
+     * @param inThreadDescriptor a <code>String</code> value
      * @param inQueue a <code>BlockingQueue&lt;Clazz&gt;</code> value
      */
     public BatchQueueProcessor(String inThreadDescriptor,

core/src/main/java/org/marketcetera/core/CloseableLock.java

@@ -2,6 +2,7 @@
 
 import java.io.Closeable;
 import java.util.concurrent.locks.Lock;
+import java.util.concurrent.locks.ReadWriteLock;
 
 import org.apache.commons.lang.Validate;
 

core/src/main/java/org/marketcetera/core/QueueMultiProcessor.java

@@ -63,7 +63,7 @@ protected void processData(Clazz inData)
      * <p>Subclasses may override this value to customize the batch size.
      * The default value is {@link Integer#MAX_VALUE}.
      *
-     * @return an <code>int</cod> value
+     * @return an <code>int</code> value
      */
     protected int getBatchSize()
     {

core/src/main/java/org/marketcetera/core/ThreadPoolMonitor.java

@@ -107,7 +107,7 @@ public long getMonitorInterval()
     /**
      * Sets the monitorInterval value.
      *
-     * @param a <code>long</code> value
+     * @param inMonitorInterval a <code>long</code> value
      */
     public void setMonitorInterval(long inMonitorInterval)
     {

core/src/main/java/org/marketcetera/core/file/DirectoryWatcher.java

@@ -1,25 +1,23 @@
 package org.marketcetera.core.file;
 
-import java.io.File;
-
 /* $License$ */
 
 /**
  * Watches the given directories for files to be added or modified.
  * 
- * <p>Instantiate a <code>DirectoryWatcher</code> implementer and {@link #setDirectoriesToWatch(File...) add} directories
- * to watch. {@link DirectoryWatcher#addWatcher(DirectoryWatcherSubscriber) Subscribe} to notifications and {@link #start() start} the
+ * <p>Instantiate a <code>DirectoryWatcher</code> implementer and add directories
+ * to watch. {@link DirectoryWatcher#addWatcher(DirectoryWatcherSubscriber) Subscribe} to notifications and start the
  * watcher.</p>
  * 
  * <p>The <code>DirectoryWatcher</code> contract directs that watchers will be notified in the order they subscribed for
  * each file that:
  * <ul>
- *   <li>exists in the directory upon the call to {@link #start start}</li>
+ *   <li>exists in the directory upon the call to start</li>
  *   <li>is added to the directory after start</li>
  * </ul>
  * 
  * <p>Watchers are notified for each file once and only once. Watcher notifications
- * are guaranteed to occur no more frequently than the interval {@link #setPollingInterval(long) set}.</p>
+ * are guaranteed to occur no more frequently than the interval set.</p>
  * 
  * <p>Implementers are guaranteed by contract to provide a thread-safe implementation.</p>
  *

core/src/main/java/org/marketcetera/core/instruments/InstrumentFromMessage.java

@@ -13,10 +13,7 @@
  * from a FIX message.
  * <p>
  * Typical usage is
- * <pre>
- * quickfix.Message message =...
- * {@link InstrumentFromMessage}.{@link #SELECTOR}.{@link DynamicInstrumentFunctionSelector#forValue(Object) forValue}(message).{@link #extract(quickfix.Message) extract}(message);
- * </pre>
+ * <pre>Instrument instrument = InstrumentFromMessage.SELECTOR.forValue(quickfix.Message).extract(quickfix.Message);</pre>
  *
  * @author anshul@marketcetera.com
  * @version $Id$

core/src/main/java/org/marketcetera/core/instruments/InstrumentToMessage.java

@@ -6,7 +6,6 @@
 
 import quickfix.DataDictionary;
 import quickfix.FieldMap;
-import quickfix.Message;
 import quickfix.field.SecurityType;
 import quickfix.field.Symbol;
 
@@ -16,16 +15,7 @@
  * instrument onto the supplied FIX message.
  * <p>
  * Typical usage is:
- * <pre>
- * Instrument instrument = ...
- * quickfix.DataDictionary dataDictionary = ...
- * String msgType = ...
- * quickfix.Message message = ...
- * InstrumentToMessage itm = {@link InstrumentToMessage}.{@link #SELECTOR}.{@link StaticInstrumentFunctionSelector#forInstrument(Instrument) forInstrument}(instrument);
- * if(itm.{@link #isSupported(quickfix.DataDictionary, String) isSupported}(dataDictionary,msgType)) {
- *     itm.{@link #set(Instrument, DataDictionary, String, Message) set}(instrument, dataDictionary, msgType, message);
- * }
- * </pre>
+ * <pre>InstrumentToMessage.SELECTOR.forInstrument(instrument).set(instrument,mMessageFactory.getBeginString(),quickfixMessage);</pre>
  *
  * @param <I> The type of instrument handled by this function
  * 
@@ -45,7 +35,7 @@ public abstract class InstrumentToMessage<I extends Instrument> extends Instrume
      * <p>
      * <b>NOTE:</b> This method is only meant to be used for unit testing.
      * It's not recommended that this method be used in production. Use
-     * {@link #set(org.marketcetera.trade.Instrument,quickfix.DataDictionary, String,quickfix.Message)} instead.
+     * {@link #set(Instrument, String, quickfix.FieldMap)} instead.
      *
      * @param inInstrument the instrument
      * @param inBeginString the begin string value of the FIX message

core/src/main/java/org/marketcetera/core/instruments/package-info.java

@@ -34,7 +34,7 @@
  * In cases when an instrument instance is not available and instrument
  * specific functionality needs to be invoked based on an arbitrary data,
  * a combination of {@link org.marketcetera.core.instruments.DynamicInstrumentFunctionSelector}
- * & {@link org.marketcetera.core.instruments.DynamicInstrumentHandler} is
+ * & {@link org.marketcetera.core.instruments.DynamicInstrumentHandler} is
  * used. These classes help dynamically select the instrument specific
  * functionality in absence of the Instrument object. See
  * {@link org.marketcetera.core.instruments.InstrumentFromMessage}