001    /* DriverPropertyInfo.java -- Property information about drivers.
002       Copyright (C) 1999 Free Software Foundation, Inc.
003    
004    This file is part of GNU Classpath.
005    
006    GNU Classpath is free software; you can redistribute it and/or modify
007    it under the terms of the GNU General Public License as published by
008    the Free Software Foundation; either version 2, or (at your option)
009    any later version.
010     
011    GNU Classpath is distributed in the hope that it will be useful, but
012    WITHOUT ANY WARRANTY; without even the implied warranty of
013    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014    General Public License for more details.
015    
016    You should have received a copy of the GNU General Public License
017    along with GNU Classpath; see the file COPYING.  If not, write to the
018    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019    02110-1301 USA.
020    
021    Linking this library statically or dynamically with other modules is
022    making a combined work based on this library.  Thus, the terms and
023    conditions of the GNU General Public License cover the whole
024    combination.
025    
026    As a special exception, the copyright holders of this library give you
027    permission to link this library with independent modules to produce an
028    executable, regardless of the license terms of these independent
029    modules, and to copy and distribute the resulting executable under
030    terms of your choice, provided that you also meet, for each linked
031    independent module, the terms and conditions of the license of that
032    module.  An independent module is a module which is not derived from
033    or based on this library.  If you modify this library, you may extend
034    this exception to your version of the library, but you are not
035    obligated to do so.  If you do not wish to do so, delete this
036    exception statement from your version. */
037    
038    
039    package java.sql;
040    
041    /**
042     * This class holds a driver property that can be used for querying or
043     * setting driver configuration parameters.
044     *
045     * @author Aaron M. Renn (arenn@urbanophile.com)
046     */
047    public class DriverPropertyInfo 
048    {
049      /**
050       * The name of the property.
051       */
052      public String name;
053    
054      /**
055       * A description of the property, possibly <code>null</code>.
056       */
057      public String description;
058    
059      /**
060       * A flag indicating whether or not a value for this property is required
061       * in order to connect to the database.
062       */
063      public boolean required;
064    
065      /**
066       * This is the value of the property.
067       */
068      public String value;
069    
070      /**
071        * If values are restricted to certain choices, this is the list of valid
072        * ones.  Otherwise it is <code>null</code>.
073        */
074      public String[] choices;
075    
076      /**
077       * This method initializes a new instance of <code>DriverPropertyInfo</code>
078       * with the specified name and value.  All other fields are defaulted.
079       *
080       * @param name The name of the property.
081       * @param value The value to assign to the property.
082       */
083      public DriverPropertyInfo(String name, String value)
084      {
085        this.name = name;
086        this.value = value;
087      }
088    }