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 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package java.sql;
  40
  41 /**
  42  * This class holds a driver property that can be used for querying or
  43  * setting driver configuration parameters.
  44  *
  45  * @author Aaron M. Renn (arenn@urbanophile.com)
  46  */
  47 public class DriverPropertyInfo
  48 {
  49   /**
  50    * The name of the property.
  51    */
  52   public String name;
  53
  54   /**
  55    * A description of the property, possibly <code>null</code>.
  56    */
  57   public String description;
  58
  59   /**
  60    * A flag indicating whether or not a value for this property is required
  61    * in order to connect to the database.
  62    */
  63   public boolean required;
  64
  65   /**
  66    * This is the value of the property.
  67    */
  68   public String value;
  69
  70   /**
  71     * If values are restricted to certain choices, this is the list of valid
  72     * ones.  Otherwise it is <code>null</code>.
  73     */
  74   public String[] choices;
  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 DriverPropertyInfo(String name, String value)
  84   {
  85     this.name = name;
  86     this.value = value;
  87   }
  88 }