Class SerialStruct
java.lang.Object
javax.sql.rowset.serial.SerialStruct
- All Implemented Interfaces:
Serializable,Cloneable,Struct
A serialized mapping in the Java programming language of an SQL
structured type. Each attribute that is not already serialized
is mapped to a serialized form, and if an attribute is itself
a structured type, each of its attributes that is not already
serialized is mapped to a serialized form.
In addition, the structured type is custom mapped to a class in the Java programming language if there is such a mapping, as are its attributes, if appropriate.
The SerialStruct class provides a constructor for creating
an instance from a Struct object, a method for retrieving
the SQL type name of the SQL structured type in the database, and methods
for retrieving its attribute values.
Thread safety
A SerialStruct is not safe for use by multiple concurrent threads. If a SerialStruct is to be used by more than one thread then access to the SerialStruct should be controlled by appropriate synchronization.- Since:
- 1.5
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionSerialStruct(SQLData in, Map<String, Class<?>> map) Constructs aSerialStructobject from the givenSQLDataobject, using the given type map to custom map it to a class in the Java programming language.SerialStruct(Struct in, Map<String, Class<?>> map) Constructs aSerialStructobject from the givenStructobject, using the givenjava.util.Mapobject for custom mapping the SQL structured type or any of its attributes that are SQL structured types. -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a clone of thisSerialStruct.booleanCompares this SerialStruct to the specified object.Object[]Retrieves an array ofObjectvalues containing the attributes of the SQL structured type that thisSerialStructobject represents.Object[]getAttributes(Map<String, Class<?>> map) Retrieves the attributes for the SQL structured type that thisSerialStructrepresents as an array ofObjectvalues, using the given type map for custom mapping if appropriate.Retrieves the SQL type name for thisSerialStructobject.inthashCode()Returns a hash code for thisSerialStruct.
-
Constructor Details
-
SerialStruct
Constructs aSerialStructobject from the givenStructobject, using the givenjava.util.Mapobject for custom mapping the SQL structured type or any of its attributes that are SQL structured types.- Parameters:
in- an instance ofStructmap- ajava.util.Mapobject in which each entry consists of 1) aStringobject giving the fully qualified name of a UDT and 2) theClassobject for theSQLDataimplementation that defines how the UDT is to be mapped- Throws:
SerialException- if an error occurs- See Also:
-
SerialStruct
Constructs aSerialStructobject from the givenSQLDataobject, using the given type map to custom map it to a class in the Java programming language. The type map gives the SQL type and the class to which it is mapped. TheSQLDataobject defines the class to which the SQL type will be mapped.- Parameters:
in- an instance of theSQLDataclass that defines the mapping of the SQL structured type to one or more objects in the Java programming languagemap- ajava.util.Mapobject in which each entry consists of 1) aStringobject giving the fully qualified name of a UDT and 2) theClassobject for theSQLDataimplementation that defines how the UDT is to be mapped- Throws:
SerialException- if an error occurs
-
-
Method Details
-
getSQLTypeName
Retrieves the SQL type name for thisSerialStructobject. This is the name used in the SQL definition of the structured type- Specified by:
getSQLTypeNamein interfaceStruct- Returns:
- a
Stringobject representing the SQL type name for the SQL structured type that thisSerialStructobject represents - Throws:
SerialException- if an error occurs
-
getAttributes
Retrieves an array ofObjectvalues containing the attributes of the SQL structured type that thisSerialStructobject represents.- Specified by:
getAttributesin interfaceStruct- Returns:
- an array of
Objectvalues, with each element being an attribute of the SQL structured type that thisSerialStructobject represents - Throws:
SerialException- if an error occurs
-
getAttributes
Retrieves the attributes for the SQL structured type that thisSerialStructrepresents as an array ofObjectvalues, using the given type map for custom mapping if appropriate.- Specified by:
getAttributesin interfaceStruct- Parameters:
map- ajava.util.Mapobject in which each entry consists of 1) aStringobject giving the fully qualified name of a UDT and 2) theClassobject for theSQLDataimplementation that defines how the UDT is to be mapped- Returns:
- an array of
Objectvalues, with each element being an attribute of the SQL structured type that thisSerialStructobject represents - Throws:
SerialException- if an error occurs
-
equals
Compares this SerialStruct to the specified object. The result istrueif and only if the argument is notnulland is aSerialStructobject whose attributes are identical to this object's attributes -
hashCode
-
clone
Returns a clone of thisSerialStruct. The copy will contain a reference to a clone of the underlying attribs array, not a reference to the original underlying attribs array of thisSerialStructobject.
-