libjava/java/sql/DriverPropertyInfo.java

   1 /* DriverPropertyInfo.java -- Property information about drivers.
   2    Copyright (C) 1999 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 USA.
  20
  21 As a special exception, if you link this library with other files to
  22 produce an executable, this library does not by itself cause the
  23 resulting executable to be covered by the GNU General Public License.
  24 This exception does not however invalidate any other reasons why the
  25 executable file might be covered by the GNU General Public License. */
  26
  27
  28 package java.sql;
  29
  30 /**
  31   * This class holds a driver property that can be used for querying or
  32   * setting driver configuration parameters.
  33   *
  34   * @author Aaron M. Renn (arenn@urbanophile.com)
  35   */
  36 public class DriverPropertyInfo
  37 {
  38
  39 /*
  40  * Instance Variables
  41  */
  42
  43 /**
  44   * The name of the property.
  45   */
  46 public String name;
  47
  48 /**
  49   * This is the value of the property.
  50   */
  51 public String value;
  52
  53 /**
  54   * A description of the property, possibly <code>null</code>.
  55   */
  56 public String description;
  57
  58 /**
  59   * A flag indicating whether or not a value for this property is required
  60   * in order to connect to the database.
  61   */
  62 public boolean required;
  63
  64 /**
  65   * If values are restricted to certain choices, this is the list of valid
  66   * ones.  Otherwise it is <code>null</code>.
  67   */
  68 public String[] choices;
  69
  70 /*************************************************************************/
  71
  72 /*
  73  * Constructors
  74  */
  75
  76 /**
  77   * This method initializes a new instance of <code>DriverPropertyInfo</code>
  78   * with the specified name and value.  All other fields are defaulted.
  79   *
  80   * @param name The name of the property.
  81   * @param value The value to assign to the property.
  82   */
  83 public
  84 DriverPropertyInfo(String name, String value)
  85 {
  86   this.name = name;
  87   this.value = value;
  88 }
  89
  90 } // DriverPropertyInfo
  91