java.lang.Object
javax.sql.rowset.serial.SerialRef
- All Implemented Interfaces:
Serializable,Cloneable,Ref
A serialized mapping of a
Ref object, which is the mapping in the
Java programming language of an SQL REF value.
The SerialRef class provides a constructor for
creating a SerialRef instance from a Ref
object and provides methods for getting and setting the Ref object.
Thread safety
A SerialRef is not safe for use by multiple concurrent threads. If a SerialRef is to be used by more than one thread then access to the SerialRef should be controlled by appropriate synchronization.- Since:
- 1.5
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a clone of thisSerialRef.booleanCompares this SerialRef to the specified object.Returns a string describing the base type name of theRef.Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.inthashCode()Returns a hash code for thisSerialRef.voidSets the SQL structured type that thisSerialRefobject references to the givenObjectobject.
-
Constructor Details
-
SerialRef
Constructs aSerialRefobject from the givenRefobject.- Parameters:
ref- a Ref object; cannot benull- Throws:
SQLException- if a database access occurs; ifrefisnull; or if theRefobject returns anullvalue base type name.SerialException- if an error occurs serializing theRefobject
-
-
Method Details
-
getBaseTypeName
Returns a string describing the base type name of theRef.- Specified by:
getBaseTypeNamein interfaceRef- Returns:
- a string of the base type name of the Ref
- Throws:
SerialException- in no Ref object has been set
-
getObject
Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers. The attributes of the structured type are mapped according to the given type map.- Specified by:
getObjectin interfaceRef- Parameters:
map- ajava.util.Mapobject containing zero or more entries, with each entry consisting of 1) aStringgiving the fully qualified name of a UDT and 2) theClassobject for theSQLDataimplementation that defines how the UDT is to be mapped- Returns:
- an object instance resolved from the Ref reference and mapped according to the supplied type map
- Throws:
SerialException- if an error is encountered in the reference resolution- See Also:
-
getObject
Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.- Specified by:
getObjectin interfaceRef- Returns:
- an object instance resolved from the Ref reference
- Throws:
SerialException- if an error is encountered in the reference resolution- See Also:
-
setObject
Sets the SQL structured type that thisSerialRefobject references to the givenObjectobject.- Specified by:
setObjectin interfaceRef- Parameters:
obj- anObjectrepresenting the SQL structured type to be referenced- Throws:
SerialException- if an error is encountered generating the the structured type referenced by thisSerialRefobject- See Also:
-
equals
Compares this SerialRef to the specified object. The result istrueif and only if the argument is notnulland is aSerialRefobject that represents the same object as this object. -
hashCode
public int hashCode()Returns a hash code for thisSerialRef. -
clone
Returns a clone of thisSerialRef. The underlyingRefobject will be set to null.
-