Stay organized with collections
Save and categorize content based on your preferences.
Struct
interface Struct
The standard mapping in the Java programming language for an SQL structured type. A Struct object contains a value for each attribute of the SQL structured type that it represents. By default, an instance ofStruct is valid as long as the application has a reference to it.
All methods on the Struct interface must be fully implemented if the JDBC driver supports the data type.
Summary
| Public methods |
| abstract Array<Any!>! |
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents.
|
| abstract Array<Any!>! |
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents.
|
| abstract String! |
Retrieves the SQL type name of the SQL structured type that this Struct object represents.
|
Public methods
getAttributes
abstract fun getAttributes(): Array<Any!>!
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents. As individual attributes are processed, this method uses the type map associated with the connection for customizations of the type mappings. If there is no entry in the connection's type map that matches the structured type that an attribute represents, the driver uses the standard mapping.
Conceptually, this method calls the method getObject on each attribute of the structured type and returns a Java array containing the result.
| Return |
Array<Any!>! |
an array containing the ordered attribute values |
| Exceptions |
java.sql.SQLException |
if a database access error occurs |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getAttributes
abstract fun getAttributes(map: MutableMap<String!, Class<*>!>!): Array<Any!>!
Produces the ordered values of the attributes of the SQL structured type that this Struct object represents. As individual attrbutes are proccessed, this method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches the structured type that an attribute represents, the driver uses the standard mapping. This method never uses the type map associated with the connection.
Conceptually, this method calls the method getObject on each attribute of the structured type and returns a Java array containing the result.
| Return |
Array<Any!>! |
an array containing the ordered attribute values |
| Exceptions |
java.sql.SQLException |
if a database access error occurs |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
getSQLTypeName
abstract fun getSQLTypeName(): String!
Retrieves the SQL type name of the SQL structured type that this Struct object represents.
| Return |
String! |
the fully-qualified type name of the SQL structured type for which this Struct object is the generic representation |
| Exceptions |
java.sql.SQLException |
if a database access error occurs |
java.sql.SQLFeatureNotSupportedException |
if the JDBC driver does not support this method |
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# Struct\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels)\n\nStruct\n======\n\n```\ninterface Struct\n```\n\n|----------------------|\n| [java.sql.Struct](#) |\n\nThe standard mapping in the Java programming language for an SQL structured type. A `Struct` object contains a value for each attribute of the SQL structured type that it represents. By default, an instance of`Struct` is valid as long as the application has a reference to it.\n\nAll methods on the `Struct` interface must be fully implemented if the JDBC driver supports the data type.\n\nSummary\n-------\n\n| Public methods ||\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)\\\u003c[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!\\\u003e! | [getAttributes](#getAttributes())`()` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. |\n| abstract [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)\\\u003c[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!\\\u003e! | [getAttributes](#getAttributes(kotlin.collections.MutableMap))`(`map:` `[MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)\u003c[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!,` `[Class](../lang/Class.html#)\u003c*\u003e!\u003e!`)` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. |\n| abstract [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | [getSQLTypeName](#getSQLTypeName())`()` Retrieves the SQL type name of the SQL structured type that this `Struct` object represents. |\n\nPublic methods\n--------------\n\n### getAttributes\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getAttributes(): Array\u003cAny!\u003e!\n```\n\nProduces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. As individual attributes are processed, this method uses the type map associated with the connection for customizations of the type mappings. If there is no entry in the connection's type map that matches the structured type that an attribute represents, the driver uses the standard mapping.\n\nConceptually, this method calls the method `getObject` on each attribute of the structured type and returns a Java array containing the result.\n\n| Return ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|\n| [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)\u003c[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!\u003e! | an array containing the ordered attribute values |\n\n| Exceptions ||\n|--------------------------------------------|-------------------------------------------------|\n| `java.sql.SQLException` | if a database access error occurs |\n| `java.sql.SQLFeatureNotSupportedException` | if the JDBC driver does not support this method |\n\n### getAttributes\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getAttributes(map: MutableMap\u003cString!, Class\u003c*\u003e!\u003e!): Array\u003cAny!\u003e!\n```\n\nProduces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. As individual attrbutes are proccessed, this method uses the given type map for customizations of the type mappings. If there is no entry in the given type map that matches the structured type that an attribute represents, the driver uses the standard mapping. This method never uses the type map associated with the connection.\n\nConceptually, this method calls the method `getObject` on each attribute of the structured type and returns a Java array containing the result.\n\n| Parameters ||\n|-------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `map` | [MutableMap](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-map/index.html)\\\u003c[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)!, [Class](../lang/Class.html#)\\\u003c\\*\\\u003e!\\\u003e!: a mapping of SQL type names to Java classes |\n\n| Return ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|\n| [Array](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html)\u003c[Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html)!\u003e! | an array containing the ordered attribute values |\n\n| Exceptions ||\n|--------------------------------------------|-------------------------------------------------|\n| `java.sql.SQLException` | if a database access error occurs |\n| `java.sql.SQLFeatureNotSupportedException` | if the JDBC driver does not support this method |\n\n### getSQLTypeName\n\nAdded in [API level 1](https://developer.android.com/guide/topics/manifest/uses-sdk-element.html#ApiLevels) \n\n```\nabstract fun getSQLTypeName(): String!\n```\n\nRetrieves the SQL type name of the SQL structured type that this `Struct` object represents.\n\n| Return ||\n|-----------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|\n| [String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)! | the fully-qualified type name of the SQL structured type for which this `Struct` object is the generic representation |\n\n| Exceptions ||\n|--------------------------------------------|-------------------------------------------------|\n| `java.sql.SQLException` | if a database access error occurs |\n| `java.sql.SQLFeatureNotSupportedException` | if the JDBC driver does not support this method |"]]
