home *** CD-ROM | disk | FTP | other *** search
/ Programming Languages Suite / ProgLangD.iso / VCAFE.3.0A / Main.bin / DriverPropertyInfo.java < prev    next >
Text File  |  1998-09-22  |  2KB  |  68 lines
  1. /*
  2.  * @(#)DriverPropertyInfo.java    1.6 98/07/01
  3.  *
  4.  * Copyright 1995-1998 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  * 
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14.  
  15. package java.sql;
  16.  
  17. /**
  18.  * <p>The DriverPropertyInfo class is only of interest to advanced programmers
  19.  * who need to interact with a Driver via getDriverProperties to discover
  20.  * and supply properties for connections.
  21.  */
  22.  
  23. public class DriverPropertyInfo {
  24.  
  25.     /**
  26.      * Constructor a DriverPropertyInfo with a name and value; other
  27.      * members default to their initial values.
  28.      *
  29.      * @param name the name of the property
  30.      * @param value the current value, which may be null
  31.      */
  32.     public DriverPropertyInfo(String name, String value) {
  33.         this.name = name;
  34.         this.value = value;
  35.     }
  36.  
  37.     /**
  38.      * The name of the property.
  39.      */
  40.     public String name;
  41.  
  42.     /**
  43.      * A brief description of the property.  This may be null.
  44.      */
  45.     public String description = null;
  46.  
  47.     /**
  48.      * "required" is true if a value must be supplied for this property
  49.      * during Driver.connect.  Otherwise the property is optional.
  50.      */
  51.     public boolean required = false;
  52.  
  53.     /**
  54.      * "value" specifies the current value of the property, based on a
  55.      * combination of the information supplied to getPropertyInfo, the
  56.      * Java environment, and driver supplied default values.  This
  57.      * may be null if no value is known.
  58.      */
  59.     public String value = null;
  60.  
  61.     /**
  62.      * If the value may be selected from a particular set of values,
  63.      * then this is an array of the possible values.  Otherwise it should
  64.      * be null.
  65.      */
  66.     public String[] choices = null;
  67. }
  68.