[ Web Proxy ]

Viewing: https://developer.android.com/reference/kotlin/java/sql/Struct

Struct | API reference | Android Developers Skip to main content

[Android Developers]

Essentials Design & Plan Develop Google Play Blog

English
Deutsch
Espaol Amrica Latina
Franais
Indonesia
Polski
Portugus Brasil
Ting Vit

Android Studio

Stay organized with collections Save and categorize content based on your preferences.

Added in API level 1

Struct

interface Struct

java.sql.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!>!	`getAttributes()` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents.
abstract Array<Any!>!	`getAttributes(map: MutableMap<String!, Class<*>!>!)` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents.
abstract String!	`getSQLTypeName()` Retrieves the SQL type name of the SQL structured type that this `Struct` object represents.

Public methods

getAttributes

Added in API level 1

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

Added in API level 1

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.

Parameters
`map`	MutableMap<String!, Class<*>!>!: a mapping of SQL type names to Java classes

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

Added in API level 1

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."],[],[]]