- 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 safetyA 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 SummaryAll 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- 
SerialRefpublic SerialRef(Ref ref) throws SerialException, SQLException Constructs aSerialRefobject from the givenRefobject.- Parameters:
- ref- a Ref object; cannot be- null
- Throws:
- SQLException- if a database access occurs; if- refis- null; or if the- Refobject returns a- nullvalue base type name.
- SerialException- if an error occurs serializing the- Refobject
 
 
- 
 - 
Method Detail- 
getBaseTypeNamepublic String getBaseTypeName() throws SerialException Returns a string describing the base type name of theRef.- Specified by:
- getBaseTypeNamein interface- Ref
- Returns:
- a string of the base type name of the Ref
- Throws:
- SerialException- in no Ref object has been set
 
 - 
getObjectpublic 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 interface- Ref
- Parameters:
- map- a- java.util.Mapobject containing zero or more entries, with each entry consisting of 1) a- Stringgiving the fully qualified name of a UDT and 2) the- Classobject for the- SQLDataimplementation 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)
 
 - 
getObjectpublic Object getObject() throws SerialException Returns anObjectrepresenting the SQL structured type to which thisSerialRefobject refers.- Specified by:
- getObjectin interface- Ref
- 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)
 
 - 
setObjectpublic void setObject(Object obj) throws SerialException Sets the SQL structured type that thisSerialRefobject references to the givenObjectobject.- Specified by:
- setObjectin interface- Ref
- Parameters:
- obj- an- Objectrepresenting the SQL structured type to be referenced
- Throws:
- SerialException- if an error is encountered generating the the structured type referenced by this- SerialRefobject
- See Also:
- Ref.getObject(),- Ref.getObject(Map),- PreparedStatement.setObject(int, Object),- CallableStatement.setObject(String, Object)
 
 - 
equalspublic 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 class- Object
- Parameters:
- obj- The object to compare this- SerialRefagainst
- Returns:
- trueif the given object represents a- SerialRefequivalent to this SerialRef,- falseotherwise
- See Also:
- Object.hashCode(),- HashMap
 
 - 
hashCodepublic int hashCode() Returns a hash code for thisSerialRef.- Overrides:
- hashCodein class- Object
- Returns:
- a hash code value for this object.
- See Also:
- Object.equals(java.lang.Object),- System.identityHashCode(java.lang.Object)
 
 
- 
 
-