Stay organized with collections
Save and categorize content based on your preferences.
DriverPropertyInfo
open class DriverPropertyInfo
Driver properties for making a connection. The DriverPropertyInfo class is of interest only to advanced programmers who need to interact with a Driver via the method getDriverProperties to discover and supply properties for connections.
Summary
| Public constructors |
|
Constructs a DriverPropertyInfo object with a given name and value.
|
| Properties |
| Array<String!>! |
An array of possible values if the value for the field DriverPropertyInfo.value may be selected from a particular set of values; otherwise null.
|
| String! |
A brief description of the property, which may be null.
|
| String! |
The name of the property.
|
| Boolean |
The required field is true if a value must be supplied for this property during Driver.connect and false otherwise.
|
| String! |
The value field specifies the current value of the property, based on a combination of the information supplied to the method getPropertyInfo, the Java environment, and the driver-supplied default values.
|
Public constructors
DriverPropertyInfo
DriverPropertyInfo(
name: String!,
value: String!)
Constructs a DriverPropertyInfo object with a given name and value. The description and choices are intialized to null and required is initialized to false.
| Parameters |
name |
String!: the name of the property |
value |
String!: the current value, which may be null |
Properties
choices
var choices: Array<String!>!
An array of possible values if the value for the field DriverPropertyInfo.value may be selected from a particular set of values; otherwise null.
description
var description: String!
A brief description of the property, which may be null.
name
var name: String!
The name of the property.
required
var required: Boolean
The required field is true if a value must be supplied for this property during Driver.connect and false otherwise.
value
var value: String!
The value field specifies the current value of the property, based on a combination of the information supplied to the method getPropertyInfo, the Java environment, and the driver-supplied default values. This field may be null if no value is known.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# DriverPropertyInfo\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nDriverPropertyInfo\n==================\n\n```\nopen class DriverPropertyInfo\n```\n\n|---|----------------------------------|\n| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) ||\n| ↳ | [java.sql.DriverPropertyInfo](#) |\n\nDriver properties for making a connection. The `DriverPropertyInfo` class is of interest only to advanced programmers who need to interact with a Driver via the method `getDriverProperties` to discover and supply properties for connections.\n\nSummary\n-------\n\n| Public constructors ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [DriverPropertyInfo](#DriverPropertyInfo(kotlin.String,%20kotlin.String))`(`name:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`, `value:` `[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!`)` Constructs a `DriverPropertyInfo` object with a given name and value. |\n\n| Properties ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)\\\u003c[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!\\\u003e! | [choices](#choices:kotlin.Array) An array of possible values if the value for the field `DriverPropertyInfo.value` may be selected from a particular set of values; otherwise null. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [description](#description:kotlin.String) A brief description of the property, which may be null. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [name](#name:kotlin.String) The name of the property. |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [required](#required:kotlin.Boolean) The `required` field is `true` if a value must be supplied for this property during `Driver.connect` and `false` otherwise. |\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [value](#value:kotlin.String) The `value` field specifies the current value of the property, based on a combination of the information supplied to the method `getPropertyInfo`, the Java environment, and the driver-supplied default values. |\n\nPublic constructors\n-------------------\n\n### DriverPropertyInfo\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nDriverPropertyInfo(\n name: String!, \n value: String!)\n```\n\nConstructs a `DriverPropertyInfo` object with a given name and value. The `description` and `choices` are intialized to `null` and `required` is initialized to `false`.\n\n| Parameters ||\n|---------|-------------------------------------------------------------------------------------------------------------------------|\n| `name` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the name of the property |\n| `value` | [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!: the current value, which may be null |\n\nProperties\n----------\n\n### choices\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar choices: Array\u003cString!\u003e!\n```\n\nAn array of possible values if the value for the field `DriverPropertyInfo.value` may be selected from a particular set of values; otherwise null. \n\n### description\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar description: String!\n```\n\nA brief description of the property, which may be null. \n\n### name\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar name: String!\n```\n\nThe name of the property. \n\n### required\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar required: Boolean\n```\n\nThe `required` field is `true` if a value must be supplied for this property during `Driver.connect` and `false` otherwise. \n\n### value\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nvar value: String!\n```\n\nThe `value` field specifies the current value of the property, based on a combination of the information supplied to the method `getPropertyInfo`, the Java environment, and the driver-supplied default values. This field may be null if no value is known."]]
