[jboss-cvs] JBossAS SVN: r110240 - in projects/jboss-jca/trunk/doc/samples/helloworld: src/main/java/org/jboss/jca/samples/helloworld and 1 other directory.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Fri Dec 31 00:36:14 EST 2010


Author: jeff.zhang
Date: 2010-12-31 00:36:14 -0500 (Fri, 31 Dec 2010)
New Revision: 110240

Modified:
   projects/jboss-jca/trunk/doc/samples/helloworld/build.xml
   projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldConnectionFactoryImpl.java
   projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnection.java
   projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnectionFactory.java
   projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldResourceAdapter.java
Log:
adjust code format for document

Modified: projects/jboss-jca/trunk/doc/samples/helloworld/build.xml
===================================================================
--- projects/jboss-jca/trunk/doc/samples/helloworld/build.xml	2010-12-31 05:17:38 UTC (rev 110239)
+++ projects/jboss-jca/trunk/doc/samples/helloworld/build.xml	2010-12-31 05:36:14 UTC (rev 110240)
@@ -127,10 +127,12 @@
       <sysproperty key="archives.dir" value="${target.dir}"/>
       <sysproperty key="java.util.logging.manager" value="org.jboss.logmanager.LogManager"/>
       <sysproperty key="log4j.defaultInitOverride" value="true"/>
-      <sysproperty key="org.jboss.logging.Logger.pluginClass" value="org.jboss.logging.logmanager.LoggerPluginImpl"/>
+      <sysproperty key="org.jboss.logging.Logger.pluginClass" 
+      	           value="org.jboss.logging.logmanager.LoggerPluginImpl"/>
       <sysproperty key="test.dir" value="${build.dir}/test"/>
       <sysproperty key="xb.builder.useUnorderedSequence" value="true"/>
-      <sysproperty key="javax.xml.stream.XMLInputFactory" value="com.sun.xml.internal.stream.XMLInputFactoryImpl"/>
+      <sysproperty key="javax.xml.stream.XMLInputFactory" 
+      	           value="com.sun.xml.internal.stream.XMLInputFactoryImpl"/>
       
       <classpath>
         <fileset dir="${lib.dir}" includes="**/*.jar" />

Modified: projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldConnectionFactoryImpl.java
===================================================================
--- projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldConnectionFactoryImpl.java	2010-12-31 05:17:38 UTC (rev 110239)
+++ projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldConnectionFactoryImpl.java	2010-12-31 05:36:14 UTC (rev 110240)
@@ -44,8 +44,8 @@
 
    /**
     * default constructor
-    * @param   mcf       ManagedConnectionFactory
-    * @param   cxManager ConnectionManager
+    * @param mcf ManagedConnectionFactory
+    * @param cxManager ConnectionManager
     */
    public HelloWorldConnectionFactoryImpl(HelloWorldManagedConnectionFactory mcf,
                                           ConnectionManager cxManager)
@@ -81,7 +81,7 @@
    /**
     * Set the Reference instance.
     *
-    * @param   reference  A Reference instance
+    * @param reference A Reference instance
     */
    @Override
    public void setReference(Reference reference)

Modified: projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnection.java
===================================================================
--- projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnection.java	2010-12-31 05:17:38 UTC (rev 110239)
+++ projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnection.java	2010-12-31 05:36:14 UTC (rev 110240)
@@ -75,10 +75,10 @@
     * Creates a new connection handle for the underlying physical connection 
     * represented by the ManagedConnection instance. 
     *
-    * @param        subject        security context as JAAS subject
-    * @param        cxRequestInfo  ConnectionRequestInfo instance
-    * @return       generic Object instance representing the connection handle. 
-    * @throws  ResourceException     generic exception if operation fails
+    * @param subject security context as JAAS subject
+    * @param cxRequestInfo ConnectionRequestInfo instance
+    * @return generic Object instance representing the connection handle. 
+    * @throws ResourceException generic exception if operation fails
     */
    public Object getConnection(Subject subject,
                                ConnectionRequestInfo cxRequestInfo) 
@@ -93,8 +93,8 @@
     * Used by the container to change the association of an 
     * application-level connection handle with a ManagedConneciton instance.
     *
-    * @param   connection  Application-level connection handle
-    * @throws  ResourceException     generic exception if operation fails
+    * @param connection Application-level connection handle
+    * @throws ResourceException generic exception if operation fails
     */
    public void associateConnection(Object connection) throws ResourceException
    {
@@ -102,9 +102,10 @@
    }
 
    /**
-    * Application server calls this method to force any cleanup on the ManagedConnection instance.
+    * Application server calls this method to force any cleanup on 
+    * the ManagedConnection instance.
     *
-    * @throws    ResourceException     generic exception if operation fails
+    * @throws ResourceException generic exception if operation fails
     */
    public void cleanup() throws ResourceException
    {
@@ -113,7 +114,7 @@
    /**
     * Destroys the physical connection to the underlying resource manager.
     *
-    * @throws    ResourceException     generic exception if operation fails
+    * @throws ResourceException generic exception if operation fails
     */
    public void destroy() throws ResourceException
    {
@@ -123,7 +124,7 @@
    /**
     * Adds a connection event listener to the ManagedConnection instance.
     *
-    * @param  listener   a new ConnectionEventListener to be registered
+    * @param listener a new ConnectionEventListener to be registered
     */
    public void addConnectionEventListener(ConnectionEventListener listener)
    {
@@ -134,9 +135,10 @@
    }
 
    /**
-    * Removes an already registered connection event listener from the ManagedConnection instance.
+    * Removes an already registered connection event listener 
+    * from the ManagedConnection instance.
     *
-    * @param  listener   already registered connection event listener to be removed
+    * @param listener already registered connection event listener to be removed
     */
    public void removeConnectionEventListener(ConnectionEventListener listener)
    {
@@ -149,8 +151,9 @@
    /**
     * Gets the log writer for this ManagedConnection instance.
     *
-    * @return  Character ourput stream associated with this Managed-Connection instance
-    * @throws ResourceException     generic exception if operation fails
+    * @return Character ourput stream associated with this 
+    *         Managed-Connection instance
+    * @throws ResourceException generic exception if operation fails
     */
    public PrintWriter getLogWriter() throws ResourceException
    {
@@ -160,8 +163,8 @@
    /**
     * Sets the log writer for this ManagedConnection instance.
     *
-    * @param      out        Character Output stream to be associated
-    * @throws     ResourceException  generic exception if operation fails
+    * @param out Character Output stream to be associated
+    * @throws ResourceException generic exception if operation fails
     */
    public void setLogWriter(PrintWriter out) throws ResourceException
    {
@@ -171,8 +174,8 @@
    /**
     * Returns an <code>javax.resource.spi.LocalTransaction</code> instance.
     *
-    * @return     LocalTransaction instance
-    * @throws ResourceException     generic exception if operation fails
+    * @return LocalTransaction instance
+    * @throws ResourceException generic exception if operation fails
     */
    public LocalTransaction getLocalTransaction() throws ResourceException
    {
@@ -182,8 +185,8 @@
    /**
     * Returns an <code>javax.transaction.xa.XAresource</code> instance. 
     *
-    * @return     XAResource instance
-    * @throws ResourceException     generic exception if operation fails
+    * @return XAResource instance
+    * @throws ResourceException generic exception if operation fails
     */
    public XAResource getXAResource() throws ResourceException
    {
@@ -191,10 +194,11 @@
    }
 
    /**
-    * Gets the metadata information for this connection's underlying EIS resource manager instance. 
+    * Gets the metadata information for this connection's underlying 
+    * EIS resource manager instance. 
     *
     * @return ManagedConnectionMetaData instance
-    * @throws ResourceException     generic exception if operation fails
+    * @throws ResourceException generic exception if operation fails
     */
    public ManagedConnectionMetaData getMetaData() throws ResourceException
    {

Modified: projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnectionFactory.java
===================================================================
--- projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnectionFactory.java	2010-12-31 05:17:38 UTC (rev 110239)
+++ projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldManagedConnectionFactory.java	2010-12-31 05:36:14 UTC (rev 110240)
@@ -71,8 +71,9 @@
    /**
     * Creates a Connection Factory instance. 
     *
-    * @return   EIS-specific Connection Factory instance or javax.resource.cci.ConnectionFactory instance
-    * @throws   ResourceException Generic exception
+    * @return EIS-specific Connection Factory instance or 
+    *         javax.resource.cci.ConnectionFactory instance
+    * @throws ResourceException Generic exception
     */
    public Object createConnectionFactory() throws ResourceException
    {
@@ -82,9 +83,11 @@
    /**
     * Creates a Connection Factory instance. 
     *
-    * @param    cxManager    ConnectionManager to be associated with created EIS connection factory instance
-    * @return   EIS-specific Connection Factory instance or javax.resource.cci.ConnectionFactory instance
-    * @throws   ResourceException Generic exception
+    * @param cxManager ConnectionManager to be associated with created EIS 
+    *        connection factory instance
+    * @return EIS-specific Connection Factory instance or 
+    *        javax.resource.cci.ConnectionFactory instance
+    * @throws ResourceException Generic exception
     */
    public Object createConnectionFactory(ConnectionManager cxManager) throws ResourceException
    {
@@ -94,10 +97,11 @@
    /**
     * Creates a new physical connection to the underlying EIS resource manager.
     *
-    * @param   subject        Caller's security information
-    * @param   cxRequestInfo  Additional resource adapter specific connection request information
-    * @throws  ResourceException     generic exception
-    * @return  ManagedConnection instance 
+    * @param subject Caller's security information
+    * @param cxRequestInfo Additional resource adapter specific connection 
+    *        request information
+    * @throws ResourceException generic exception
+    * @return ManagedConnection instance 
     */
    public ManagedConnection createManagedConnection(Subject subject,
                                                     ConnectionRequestInfo cxRequestInfo) 
@@ -109,11 +113,11 @@
    /**
     * Returns a matched connection from the candidate set of connections. 
     *
-    * @param   connectionSet   candidate connection set
-    * @param   subject        Caller's security information
-    * @param   cxRequestInfo  Additional resource adapter specific connection request information
-    * @throws  ResourceException     generic exception
-    * @return  ManagedConnection if resource adapter finds an acceptable match otherwise null 
+    * @param connectionSet candidate connection set
+    * @param subject Caller's security information
+    * @param cxRequestInfo Additional resource adapter specific connection request information
+    * @throws ResourceException generic exception
+    * @return ManagedConnection if resource adapter finds an acceptable match otherwise null 
     */
    public ManagedConnection matchManagedConnections(Set connectionSet,
                                                     Subject subject, ConnectionRequestInfo cxRequestInfo) 
@@ -138,8 +142,8 @@
    /**
     * Get the log writer for this ManagedConnectionFactory instance.
     *
-    * @return  PrintWriter
-    * @throws  ResourceException     generic exception
+    * @return PrintWriter
+    * @throws ResourceException generic exception
     */
    public PrintWriter getLogWriter() throws ResourceException
    {
@@ -149,8 +153,8 @@
    /**
     * Set the log writer for this ManagedConnectionFactory instance.
     *
-    * @param   out PrintWriter - an out stream for error logging and tracing
-    * @throws  ResourceException     generic exception
+    * @param out PrintWriter - an out stream for error logging and tracing
+    * @throws ResourceException generic exception
     */
    public void setLogWriter(PrintWriter out) throws ResourceException
    {
@@ -190,7 +194,7 @@
 
    /** 
     * Indicates whether some other object is equal to this one.
-    * @param   other   the reference object with which to compare.
+    * @param other the reference object with which to compare.
     * @return true if this object is the same as the obj argument; false otherwise.
     */
    @Override

Modified: projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldResourceAdapter.java
===================================================================
--- projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldResourceAdapter.java	2010-12-31 05:17:38 UTC (rev 110239)
+++ projects/jboss-jca/trunk/doc/samples/helloworld/src/main/java/org/jboss/jca/samples/helloworld/HelloWorldResourceAdapter.java	2010-12-31 05:36:14 UTC (rev 110240)
@@ -149,7 +149,7 @@
 
    /** 
     * Indicates whether some other object is equal to this one.
-    * @param   other   the reference object with which to compare.
+    * @param other the reference object with which to compare.
     * @return true if this object is the same as the obj argument; false otherwise.
     */
    @Override



More information about the jboss-cvs-commits mailing list