From 4d8daa730604a437abd0f49c647d0e5bc4304b21 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Wed, 17 Mar 2004 08:31:22 +0000 Subject: [PATCH] More Javadoc fixes. --- src/net/java/dev/simplepool/SimplePool.java | 4 +- .../dev/simplepool/SimplePoolConnection.java | 68 ++++++++++++------- .../dev/simplepool/SimplePoolDataSource.java | 18 ++--- .../SimplePoolDataSourceFactory.java | 2 +- .../dev/simplepool/SimplePoolServlet.java | 54 ++++++++++----- 5 files changed, 93 insertions(+), 53 deletions(-) diff --git a/src/net/java/dev/simplepool/SimplePool.java b/src/net/java/dev/simplepool/SimplePool.java index 4891017..d359340 100644 --- a/src/net/java/dev/simplepool/SimplePool.java +++ b/src/net/java/dev/simplepool/SimplePool.java @@ -1,4 +1,4 @@ -/** +/* * $Source$ * $Revision$ * $Date$ @@ -64,7 +64,7 @@ public class SimplePool implements Runnable { /** - * Creates a new Connection Broker + * Creates a new Connection Broker. * * @param driver JDBC driver. e.g. 'oracle.jdbc.driver.OracleDriver' * @param jdbcUrl JDBC connect string. e.g. 'jdbc:oracle:thin:@203.92.21.109:1526:orcl' diff --git a/src/net/java/dev/simplepool/SimplePoolConnection.java b/src/net/java/dev/simplepool/SimplePoolConnection.java index 66ce9f4..e5ba946 100644 --- a/src/net/java/dev/simplepool/SimplePoolConnection.java +++ b/src/net/java/dev/simplepool/SimplePoolConnection.java @@ -1,20 +1,40 @@ -/** - * $Source$ $Revision: 1.1 - * $ $Date$ Copyright (c) 2004, Russell Beattie (http://www.russellbeattie.com/) All rights - * reserved. Copyright (c) 2004, Erik C. Thauvin (http://www.thauvin.net/erik/) All rights reserved. Redistribution - * and use in source and binary forms, with or without modification, are permitted provided that the following - * conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list - * of conditions and the following disclaimer in the documentation and/or other materials provided with the - * distribution. Neither the name of the authors nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE - * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, - * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL - * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, - * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, - * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* + * $Source$ + * $Revision$ + * $Date$ + * + * Copyright (c) 2004, Russell Beattie (http://www.russellbeattie.com/) + * All rights reserved. + * + * Copyright (c) 2004, Erik C. Thauvin (http://www.thauvin.net/erik/) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Neither the name of the authors nor the names of its contributors may be + * used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, + * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package net.java.dev.simplepool; @@ -23,7 +43,7 @@ import java.util.Map; /** - * Basic implementation of javax.sql.Connnection. + * Basic implementation of {@link java.sql.Connection}. * * @author Russell Beattie * @author Erik C. Thauvin @@ -33,16 +53,16 @@ import java.util.Map; public class SimplePoolConnection implements Connection { private Connection conn; - private SimplePool broker; + private SimplePool pool; /** * Creates a new SimplePoolConnection object. * - * @param broker The connection pool. + * @param pool The connection pool. */ - public SimplePoolConnection(SimplePool broker) { - this.broker = broker; - conn = broker.getConnection(); + public SimplePoolConnection(SimplePool pool) { + this.pool = pool; + conn = pool.getConnection(); } /** @@ -232,7 +252,7 @@ public class SimplePoolConnection implements Connection { */ public void close() throws SQLException { - broker.freeConnection(conn); + pool.freeConnection(conn); } /** diff --git a/src/net/java/dev/simplepool/SimplePoolDataSource.java b/src/net/java/dev/simplepool/SimplePoolDataSource.java index 0d61f8f..47b1362 100644 --- a/src/net/java/dev/simplepool/SimplePoolDataSource.java +++ b/src/net/java/dev/simplepool/SimplePoolDataSource.java @@ -1,4 +1,4 @@ -/** +/* * $Source$ * $Revision$ * $Date$ @@ -44,7 +44,7 @@ import java.sql.Connection; import java.sql.SQLException; /** - * Basic implementation of javax.sql.DataSource. + * Basic implementation of {@link javax.sql.DataSource}. * * @author Russell Beattie * @author Erik C. Thauvin @@ -53,8 +53,8 @@ import java.sql.SQLException; */ public class SimplePoolDataSource implements DataSource { - protected PrintWriter logWriter = new PrintWriter(System.out); - protected SimplePool broker = null; + private PrintWriter logWriter = new PrintWriter(System.out); + private SimplePool pool = null; private String driver = ""; private String jdbcUrl = ""; @@ -72,7 +72,7 @@ public class SimplePoolDataSource implements DataSource { */ protected void init() throws Exception { - broker = new SimplePool(driver, jdbcUrl, user, password, + pool = new SimplePool(driver, jdbcUrl, user, password, Integer.parseInt(minConns), Integer.parseInt(maxConns), Double.parseDouble(maxConnTime), Integer.parseInt(maxCheckoutSeconds)); @@ -85,7 +85,7 @@ public class SimplePoolDataSource implements DataSource { */ public Connection getConnection() throws SQLException { - if (broker == null) { + if (pool == null) { try { init(); } catch (Exception e) { @@ -93,7 +93,7 @@ public class SimplePoolDataSource implements DataSource { } } - return new SimplePoolConnection(broker); + return new SimplePoolConnection(pool); } @@ -148,8 +148,8 @@ public class SimplePoolDataSource implements DataSource { * Closes the connection pool. */ public void close() { - broker.destroy(); - broker = null; + pool.destroy(); + pool = null; } /** diff --git a/src/net/java/dev/simplepool/SimplePoolDataSourceFactory.java b/src/net/java/dev/simplepool/SimplePoolDataSourceFactory.java index 070d373..63b18c2 100644 --- a/src/net/java/dev/simplepool/SimplePoolDataSourceFactory.java +++ b/src/net/java/dev/simplepool/SimplePoolDataSourceFactory.java @@ -1,4 +1,4 @@ -/** +/* * $Source$ * $Revision$ * $Date$ diff --git a/src/net/java/dev/simplepool/SimplePoolServlet.java b/src/net/java/dev/simplepool/SimplePoolServlet.java index d122799..1ba9c43 100644 --- a/src/net/java/dev/simplepool/SimplePoolServlet.java +++ b/src/net/java/dev/simplepool/SimplePoolServlet.java @@ -1,20 +1,40 @@ -/** - * $Source$ $Revision$ - * $Date$ Copyright (c) 2004, Russell Beattie (http://www.russellbeattie.com/) All rights - * reserved. Copyright (c) 2004, Erik C. Thauvin (http://www.thauvin.net/erik/) All rights reserved. Redistribution - * and use in source and binary forms, with or without modification, are permitted provided that the following - * conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions - * and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list - * of conditions and the following disclaimer in the documentation and/or other materials provided with the - * distribution. Neither the name of the authors nor the names of its contributors may be used to endorse or promote - * products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE - * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, - * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL - * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR - * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, - * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, - * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, - * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +/* + * $Source$ + * $Revision$ + * $Date$ + * + * Copyright (c) 2004, Russell Beattie (http://www.russellbeattie.com/) + * All rights reserved. + * + * Copyright (c) 2004, Erik C. Thauvin (http://www.thauvin.net/erik/) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * + * Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions and the following disclaimer in the documentation + * and/or other materials provided with the distribution. + * + * Neither the name of the authors nor the names of its contributors may be + * used to endorse or promote products derived from this software without + * specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, + * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR + * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR + * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, + * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, + * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ package net.java.dev.simplepool;