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
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of thisSerialRef
.boolean
Compares this SerialRef to the specified object.Returns a string describing the base type name of theRef
.Returns anObject
representing the SQL structured type to which thisSerialRef
object refers.Returns anObject
representing the SQL structured type to which thisSerialRef
object refers.int
hashCode()
Returns a hash code for thisSerialRef
.void
Sets the SQL structured type that thisSerialRef
object references to the givenObject
object.
-
Constructor Details
-
SerialRef
Constructs aSerialRef
object from the givenRef
object.- Parameters:
ref
- a Ref object; cannot benull
- Throws:
SQLException
- if a database access occurs; ifref
isnull
; or if theRef
object returns anull
value base type name.SerialException
- if an error occurs serializing theRef
object
-
-
Method Details
-
getBaseTypeName
Returns a string describing the base type name of theRef
.- Specified by:
getBaseTypeName
in interfaceRef
- Returns:
- a string of the base type name of the Ref
- Throws:
SerialException
- in no Ref object has been set
-
getObject
Returns anObject
representing the SQL structured type to which thisSerialRef
object refers. The attributes of the structured type are mapped according to the given type map.- Specified by:
getObject
in interfaceRef
- Parameters:
map
- ajava.util.Map
object containing zero or more entries, with each entry consisting of 1) aString
giving the fully qualified name of a UDT and 2) theClass
object for theSQLData
implementation 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 anObject
representing the SQL structured type to which thisSerialRef
object refers.- Specified by:
getObject
in 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 thisSerialRef
object references to the givenObject
object.- Specified by:
setObject
in interfaceRef
- Parameters:
obj
- anObject
representing the SQL structured type to be referenced- Throws:
SerialException
- if an error is encountered generating the the structured type referenced by thisSerialRef
object- See Also:
-
equals
Compares this SerialRef to the specified object. The result istrue
if and only if the argument is notnull
and is aSerialRef
object 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 underlyingRef
object will be set to null.
-