- java.lang.Object
-
- javax.sql.rowset.serial.SerialRef
-
- All Implemented Interfaces:
Serializable,Cloneable,Ref
public class SerialRef extends Object implements Ref, Serializable, Cloneable
A serialized mapping of aRefobject, which is the mapping in the Java programming language of an SQLREFvalue.The
SerialRefclass provides a constructor for creating aSerialRefinstance from aRefobject and provides methods for getting and setting theRefobject.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:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Objectclone()Returns a clone of thisSerialRef.booleanequals(Object obj)Compares this SerialRef to the specified object.StringgetBaseTypeName()Returns a string describing the base type name of theRef.ObjectgetObject()Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.ObjectgetObject(Map<String,Class<?>> map)Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.inthashCode()Returns a hash code for thisSerialRef.voidsetObject(Object obj)Sets the SQL structured type that thisSerialRefobject references to the givenObjectobject.
-
-
-
Constructor Detail
-
SerialRef
public SerialRef(Ref ref) throws SerialException, SQLException
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 Detail
-
getBaseTypeName
public String getBaseTypeName() throws SerialException
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
public Object getObject(Map<String,Class<?>> map) throws SerialException
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:
Ref.setObject(java.lang.Object)
-
getObject
public Object getObject() throws SerialException
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:
Ref.setObject(java.lang.Object)
-
setObject
public void setObject(Object obj) throws SerialException
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:
Ref.getObject(),Ref.getObject(Map),PreparedStatement.setObject(int, Object),CallableStatement.setObject(String, Object)
-
equals
public boolean equals(Object obj)
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.- Overrides:
equalsin classObject- Parameters:
obj- The object to compare thisSerialRefagainst- Returns:
trueif the given object represents aSerialRefequivalent to this SerialRef,falseotherwise- See Also:
Object.hashCode()
-
hashCode
public int hashCode()
Returns a hash code for thisSerialRef.- Overrides:
hashCodein classObject- Returns:
- a hash code value for this object.
- See Also:
Object.equals(java.lang.Object)
-
-