Stay organized with collections
Save and categorize content based on your preferences.
Struct
public
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
Object[]
|
getAttributes(Map<String, Class<?>> map)
Produces the ordered values of the attributes of the SQL
structured type that this Struct object represents.
|
abstract
Object[]
|
getAttributes()
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
public abstract Object[] getAttributes (Map<String, Class<?>> map)
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 |
Map: a mapping of SQL type names to Java classes |
| Returns |
|---|
Object[] |
an array containing the ordered attribute values |
getAttributes
public abstract Object[] getAttributes ()
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.
| Returns |
|---|
Object[] |
an array containing the ordered attribute values |
getSQLTypeName
public abstract String getSQLTypeName ()
Retrieves the SQL type name of the SQL structured type
that this Struct object represents.
| Returns |
|---|
String |
the fully-qualified type name of the SQL structured
type for which this Struct object
is the generic representation |
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](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\nStruct\n======\n\n\n`\npublic\n\n\ninterface\nStruct\n`\n\n\n`\n\n\n`\n\n|-----------------|\n| java.sql.Struct |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\n\u003cbr /\u003e\n\nThe standard mapping in the Java programming language for an SQL\nstructured type. A `Struct` object contains a\nvalue for each attribute of the SQL structured type that\nit represents.\nBy default, an instance of`Struct` is valid as long as the\napplication has a reference to it.\n\n\nAll methods on the `Struct` interface must be fully implemented if the\nJDBC driver supports the data type.\n\nSummary\n-------\n\n| ### Public methods ||\n|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` abstract `[Object[]](/reference/java/lang/Object) | ` `[getAttributes](/reference/java/sql/Struct#getAttributes(java.util.Map\u003cjava.lang.String,java.lang.Class\u003c?\u003e\u003e))`(`[Map](/reference/java/util/Map)`\u003c`[String](/reference/java/lang/String)`, `[Class](/reference/java/lang/Class)`\u003c?\u003e\u003e map) ` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. |\n| ` abstract `[Object[]](/reference/java/lang/Object) | ` `[getAttributes](/reference/java/sql/Struct#getAttributes())`() ` Produces the ordered values of the attributes of the SQL structured type that this `Struct` object represents. |\n| ` abstract `[String](/reference/java/lang/String) | ` `[getSQLTypeName](/reference/java/sql/Struct#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](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract Object[] getAttributes (Map\u003cString, Class\u003c?\u003e\u003e map)\n```\n\nProduces the ordered values of the attributes of the SQL\nstructured type that this `Struct` object represents.\nAs individual attrbutes are proccessed, this method uses the given type map\nfor customizations of the type mappings.\nIf there is no\nentry in the given type map that matches the structured\ntype that an attribute represents,\nthe driver uses the standard mapping. This method never\nuses the type map associated with the connection.\n\n\nConceptually, this method calls the method\n`getObject` on each attribute\nof the structured type and returns a Java array containing\nthe result.\n\n\u003cbr /\u003e\n\n| Parameters ||\n|-------|-----------------------------------------------------------|\n| `map` | `Map`: a mapping of SQL type names to Java classes \u003cbr /\u003e |\n\n| Returns ||\n|-----------------------------------------|---------------------------------------------------------|\n| [Object[]](/reference/java/lang/Object) | an array containing the ordered attribute values \u003cbr /\u003e |\n\n| Throws ||\n|----------------------------------------------------------------------------------------|-------------------------------------------------|\n| [SQLException](/reference/java/sql/SQLException) | if a database access error occurs |\n| [SQLFeatureNotSupportedException](/reference/java/sql/SQLFeatureNotSupportedException) | if the JDBC driver does not support this method |\n\n### getAttributes\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract Object[] getAttributes ()\n```\n\nProduces the ordered values of the attributes of the SQL\nstructured type that this `Struct` object represents.\nAs individual attributes are processed, this method uses the type map\nassociated with the\nconnection for customizations of the type mappings.\nIf there is no\nentry in the connection's type map that matches the structured\ntype that an attribute represents,\nthe driver uses the standard mapping.\n\n\nConceptually, this method calls the method\n`getObject` on each attribute\nof the structured type and returns a Java array containing\nthe result.\n\n\u003cbr /\u003e\n\n| Returns ||\n|-----------------------------------------|---------------------------------------------------------|\n| [Object[]](/reference/java/lang/Object) | an array containing the ordered attribute values \u003cbr /\u003e |\n\n| Throws ||\n|----------------------------------------------------------------------------------------|-------------------------------------------------|\n| [SQLException](/reference/java/sql/SQLException) | if a database access error occurs |\n| [SQLFeatureNotSupportedException](/reference/java/sql/SQLFeatureNotSupportedException) | if the JDBC driver does not support this method |\n\n### getSQLTypeName\n\nAdded in [API level 1](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic abstract String getSQLTypeName ()\n```\n\nRetrieves the SQL type name of the SQL structured type\nthat this `Struct` object represents.\n\n\u003cbr /\u003e\n\n| Returns ||\n|---------------------------------------|------------------------------------------------------------------------------------------------------------------------------|\n| [String](/reference/java/lang/String) | the fully-qualified type name of the SQL structured type for which this `Struct` object is the generic representation \u003cbr /\u003e |\n\n| Throws ||\n|----------------------------------------------------------------------------------------|-------------------------------------------------|\n| [SQLException](/reference/java/sql/SQLException) | if a database access error occurs |\n| [SQLFeatureNotSupportedException](/reference/java/sql/SQLFeatureNotSupportedException) | if the JDBC driver does not support this method |"]]
