You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2013/09/09 19:34:23 UTC
svn commit: r1521212 - in
/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer:
./ socket/ vinci/ vns/
Author: schor
Date: Mon Sep 9 17:34:22 2013
New Revision: 1521212
URL: http://svn.apache.org/r1521212
Log:
[UIMA-3256] fixup Javadocs
Modified:
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/DeployFactory.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/ProcessControllerAdapter.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java
uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/CPEDeployerDefaultImpl.java Mon Sep 9 17:34:22 2013
@@ -72,9 +72,9 @@ public class CPEDeployerDefaultImpl impl
* processing thread created here. The <i>aCasProcessorList</i> contains instantiated Cas
* Processors. These are instantiated by the CPEFactory.
*
- * @param -
- * aCasProcessorList - list containing instantiated Cas Processors
- * @redeploy - true when redeploying failed Cas Processor
+ * @param aCasProcessorList - list containing instantiated Cas Processors
+ * @param aEngine the CPM engine
+ * @param redeploy - true when redeploying failed Cas Processor
*
* @return - ProcessingContainer containing pool of CasProcessors
*/
@@ -90,9 +90,8 @@ public class CPEDeployerDefaultImpl impl
* processing thread created here. The <i>aCasProcessorList</i> contains instantiated Cas
* Processors. These are instantiated by the CPEFactory.
*
- * @param -
- * aCasProcessorList - list containing instantiated Cas Processors
- * @redeploy - true when redeploying failed Cas Processor
+ * @param aCasProcessorList - list containing instantiated Cas Processors
+ * @param redeploy - true when redeploying failed Cas Processor
*
* @return - ProcessingContainer containing pool of CasProcessors
*/
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/DeployFactory.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/DeployFactory.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/DeployFactory.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/DeployFactory.java Mon Sep 9 17:34:22 2013
@@ -49,18 +49,16 @@ public class DeployFactory {
private DeployFactory() {
}
-
+
/**
* Returns a
* {@link org.apache.uima.collection.impl.base_cpm.container.deployer.CasProcessorDeployer} object
* that specializes in deploying components as either local, remote, or integrated.
*
- * @param aCpeFactory -
- * cpe configuration reference
- * @param aDeployMode -
- * mode of deployment.
- * @return - appropriate deployer object for the mode of depolyment
- *
+ * @param aCpeFactory cpe factory
+ * @param aCasProcessorConfig cpe configuration reference
+ * @param aPca mode of deployment.
+ * @return appropriate deployer object for the mode of depolyment
* @throws ResourceConfigurationException
*/
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/JavaApplication.java Mon Sep 9 17:34:22 2013
@@ -58,12 +58,12 @@ public class JavaApplication extends Run
}
/**
- * Sets up command line used to launch Cas Processor in a seperate process. Combines environment
+ * Sets up command line used to launch Cas Processor in a separate process. Combines environment
* variables setup in the CPE descriptor with a System environment variables.
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aJaxbCasProcessorConfig
+ * @param aCasProcessor
* @throws ResourceConfigurationException
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
@@ -186,9 +186,9 @@ public class JavaApplication extends Run
}
/**
- * Returns exceutable section of the CPE Descriptor for
+ * Returns executable section of the CPE Descriptor for
*
- * @return
+ * @return executable section of the CPE Descriptor
*/
public Execute getExecSpec() {
return exec;
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/NonJavaApplication.java Mon Sep 9 17:34:22 2013
@@ -54,7 +54,7 @@ public class NonJavaApplication extends
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aJaxbCasProcessorConfig
+ * @param aCasProcessor
* @throws ResourceConfigurationException
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
@@ -122,7 +122,7 @@ public class NonJavaApplication extends
}
/**
- * @return
+ * @return the executable part
*/
public Execute getExecSpec() {
return exec;
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/RunnableApplication.java Mon Sep 9 17:34:22 2013
@@ -54,7 +54,7 @@ public class RunnableApplication {
*
* @param aCasProcessorConfiguration -
* access to Cas Processor configuration
- * @param aJaxbCasProcessorConfig
+ * @param aCasProcessor
* @throws ResourceConfigurationException
*/
protected void addApplicationInfo(CasProcessorConfiguration aCasProcessorConfiguration,
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/VinciTAP.java Mon Sep 9 17:34:22 2013
@@ -411,7 +411,7 @@ public class VinciTAP {
/**
* Send a given Vinci Frame to the remote vinci service and return result
*
- * @param AFrame -
+ * @param aFrame -
* Vinci Frame containing request
*
* @return AFrame - Frame containing result
@@ -1389,7 +1389,7 @@ public class VinciTAP {
/**
* Sets the VNS host this proxy will use to locate service
*
- * @param host -
+ * @param aVNSHost -
* name of the VNS host
*/
public void setVNSHost(String aVNSHost) {
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/ProcessControllerAdapter.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/ProcessControllerAdapter.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/ProcessControllerAdapter.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/ProcessControllerAdapter.java Mon Sep 9 17:34:22 2013
@@ -31,11 +31,9 @@ public interface ProcessControllerAdapte
* Deploys given number of CasProcessors and returns their endpoint configuration( host,port).
* This method blocks until all Connections are resolved or an error occurs.
*
- * @param -
- * aCasProcessorName -name of the fenced CasProcessor
+ * @param aCasProcessorName -name of the fenced CasProcessor
*
- * @param -
- * howMany - how many CasProcessor instances to deploy
+ * @param howMany - how many CasProcessor instances to deploy
*
* @return - URL[] - list of URLs containing endpoint info
*
@@ -47,8 +45,7 @@ public interface ProcessControllerAdapte
/**
* Stops a given CasProcessor service.
*
- * @param -
- * aURL - service endpoint.
+ * @param aURL - service endpoint.
*
*/
public void undeploy(URL aURL);
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketCasProcessorDeployer.java Mon Sep 9 17:34:22 2013
@@ -75,9 +75,8 @@ public class SocketCasProcessorDeployer
* processing thread created here. The <i>aCasProcessorList</i> contains instantiated Cas
* Processors. These are instantiated by the CPEFactory.
*
- * @param -
- * aCasProcessorList - list containing instantiated Cas Processors
- * @redeploy - true when redeploying failed Cas Processor
+ * @param aCasProcessorList - list containing instantiated Cas Processors
+ * @param redeploy - true when redeploying failed Cas Processor
*
* @return - ProcessingContainer containing pool of CasProcessors
*/
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/socket/SocketTransport.java Mon Sep 9 17:34:22 2013
@@ -44,10 +44,8 @@ public interface SocketTransport {
* Creates a socket connection to a given endpoint. This method blocks until all Connections are
* resolved or an error occurs.
*
- * @param -
- * aURI - URI containing service endpoint info: host&port
- * @param -
- * aTimeout - max time in millis to wait for response
+ * @param aURI - URI containing service endpoint info: host&port
+ * @param aTimeout - max time in millis to wait for response
*
* @return - Socket bound to a given endpoint
*
@@ -59,10 +57,8 @@ public interface SocketTransport {
/**
* Invokes fenced CasProcessor.
*
- * @param -
- * aSocket - Socket bound to fenced CasProcessor
- * @param -
- * aCas - CAS to be sent to the CasProcessor for analysis
+ * @param aSocket - Socket bound to fenced CasProcessor
+ * @param aCas - CAS to be sent to the CasProcessor for analysis
*
* @return - CAS - CAS returned from the fenced CasProcessor
*
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vinci/VinciCasProcessorDeployer.java Mon Sep 9 17:34:22 2013
@@ -146,9 +146,8 @@ public class VinciCasProcessorDeployer i
* processing thread created here. The <i>aCasProcessorList</i> contains instantiated Cas
* Processors. These are instantiated by the CPEFactory.
*
- * @param -
- * aCasProcessorList - list containing instantiated Cas Processors
- * @redeploy - true when redeploying failed Cas Processor
+ * @param aCasProcessorList - list containing instantiated Cas Processors
+ * @param redeploy - true when redeploying failed Cas Processor
*
* @return - ProcessingContainer containing pool of CasProcessors
*/
@@ -197,7 +196,7 @@ public class VinciCasProcessorDeployer i
* vinci service and creating a connection to it. For un-managed Cas Processor the CPE establishes
* the connection.
*
- * @param aCasProcessorList-
+ * @param aCasProcessorList -
* list of CasProcessors to deploy
* @param redeploy -
* true if intent is to redeploy failed service
Modified: uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java?rev=1521212&r1=1521211&r2=1521212&view=diff
==============================================================================
--- uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java (original)
+++ uima/uimaj/trunk/uimaj-cpe/src/main/java/org/apache/uima/collection/impl/cpm/container/deployer/vns/LocalVNS.java Mon Sep 9 17:34:22 2013
@@ -62,8 +62,6 @@ public class LocalVNS extends VinciServa
/**
* Instantiates Local Vinci Naming Service
*
- * @param aProcessor -
- * CASProcessor instantiating this VNS (the owner)
* @param aStartPort -
* a starting port # for clients (services)
* @param aEndPort -
@@ -183,8 +181,7 @@ public class LocalVNS extends VinciServa
* Determines if a given port is free. It establishes a short lived connection to the port and if
* successful returns false.
*
- * @param -
- * port number to check
+ * @param port number to check
*/
public boolean isAvailable(int port) {
ServerSocket socket = null;