src/share/classes/javax/sql/CommonDataSource.java

Print this page
rev 10065 : 8046389: Add missing @since tag under javax.sql.**
Reviewed-by:


  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.sql;
  27 
  28 import java.sql.SQLException;
  29 import java.io.PrintWriter;
  30 import java.sql.SQLFeatureNotSupportedException;
  31 import java.util.logging.Logger;
  32 
  33 /**
  34  * Interface that defines the methods which are common between <code>DataSource</code>,
  35  * <code>XADataSource</code> and <code>ConnectionPoolDataSource</code>.
  36  *

  37  */
  38 public interface CommonDataSource {
  39 
  40     /**
  41      * <p>Retrieves the log writer for this <code>DataSource</code>
  42      * object.
  43      *
  44      * <p>The log writer is a character output stream to which all logging
  45      * and tracing messages for this data source will be
  46      * printed.  This includes messages printed by the methods of this
  47      * object, messages printed by methods of other objects manufactured
  48      * by this object, and so on.  Messages printed to a data source
  49      * specific log writer are not printed to the log writer associated
  50      * with the <code>java.sql.DriverManager</code> class.  When a
  51      * <code>DataSource</code> object is
  52      * created, the log writer is initially null; in other words, the
  53      * default is for logging to be disabled.
  54      *
  55      * @return the log writer for this data source or null if
  56      *        logging is disabled




  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.sql;
  27 
  28 import java.sql.SQLException;
  29 import java.io.PrintWriter;
  30 import java.sql.SQLFeatureNotSupportedException;
  31 import java.util.logging.Logger;
  32 
  33 /**
  34  * Interface that defines the methods which are common between <code>DataSource</code>,
  35  * <code>XADataSource</code> and <code>ConnectionPoolDataSource</code>.
  36  *
  37  * @since 1.6
  38  */
  39 public interface CommonDataSource {
  40 
  41     /**
  42      * <p>Retrieves the log writer for this <code>DataSource</code>
  43      * object.
  44      *
  45      * <p>The log writer is a character output stream to which all logging
  46      * and tracing messages for this data source will be
  47      * printed.  This includes messages printed by the methods of this
  48      * object, messages printed by methods of other objects manufactured
  49      * by this object, and so on.  Messages printed to a data source
  50      * specific log writer are not printed to the log writer associated
  51      * with the <code>java.sql.DriverManager</code> class.  When a
  52      * <code>DataSource</code> object is
  53      * created, the log writer is initially null; in other words, the
  54      * default is for logging to be disabled.
  55      *
  56      * @return the log writer for this data source or null if
  57      *        logging is disabled