SerialRef (Java Platform SE 6) (original) (raw)
javax.sql.rowset.serial
Class SerialRef
java.lang.Object
javax.sql.rowset.serial.SerialRef
All Implemented Interfaces:
public class SerialRef
extends Object
implements Ref, Serializable, Cloneable
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.
See Also:
| Constructor Summary |
|---|
| SerialRef(Ref ref) Constructs a SerialRef object from the given Ref object. |
| Method Summary | |
|---|---|
| String | getBaseTypeName() Returns a string describing the base type name of the Ref. |
| Object | getObject() Returns an Object representing the SQL structured type to which this SerialRef object refers. |
| Object | getObject(Map<String,Class<?>> map) Returns an Object representing the SQL structured type to which this SerialRef object refers. |
| void | setObject(Object obj) Sets the SQL structured type that this SerialRef object references to the given Object object. |
| Methods inherited from class java.lang.Object |
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, [wait](../../../../java/lang/Object.html#wait%28long, int%29) |
| Constructor Detail |
|---|
SerialRef
public SerialRef(Ref ref) throws SerialException, SQLException
Constructs a SerialRef object from the given Ref object.
Parameters:
ref - a Ref object; cannot be null
Throws:
[SQLException](../../../../java/sql/SQLException.html "class in java.sql") - if a database access occurs; if ref is null; or if the Ref object returns anull value base type name.
[SerialException](../../../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial") - if an error occurs serializing the Ref object
| Method Detail |
|---|
getBaseTypeName
public String getBaseTypeName() throws SerialException
Returns a string describing the base type name of the Ref.
Specified by:
[getBaseTypeName](../../../../java/sql/Ref.html#getBaseTypeName%28%29) in interface [Ref](../../../../java/sql/Ref.html "interface in java.sql")
Returns:
a string of the base type name of the Ref
Throws:
[SerialException](../../../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial") - in no Ref object has been set
getObject
public Object getObject(Map<String,Class<?>> map) throws SerialException
Returns an Object representing the SQL structured type to which this SerialRef object refers. The attributes of the structured type are mapped according to the given type map.
Specified by:
[getObject](../../../../java/sql/Ref.html#getObject%28java.util.Map%29) in interface [Ref](../../../../java/sql/Ref.html "interface in java.sql")
Parameters:
map - a java.util.Map object containing zero or more entries, with each entry consisting of 1) a String giving the fully qualified name of a UDT and 2) theClass object for the SQLData 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](../../../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial") - if an error is encountered in the reference resolution
See Also:
Ref.setObject(java.lang.Object)
getObject
public Object getObject() throws SerialException
Returns an Object representing the SQL structured type to which this SerialRef object refers.
Specified by:
[getObject](../../../../java/sql/Ref.html#getObject%28%29) in interface [Ref](../../../../java/sql/Ref.html "interface in java.sql")
Returns:
an object instance resolved from the Ref reference
Throws:
[SerialException](../../../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial") - 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 this SerialRef object references to the given Object object.
Specified by:
[setObject](../../../../java/sql/Ref.html#setObject%28java.lang.Object%29) in interface [Ref](../../../../java/sql/Ref.html "interface in java.sql")
Parameters:
obj - an Object representing the SQL structured type to be referenced
Throws:
[SerialException](../../../../javax/sql/rowset/serial/SerialException.html "class in javax.sql.rowset.serial") - if an error is encountered generating the the structured type referenced by this SerialRef object
See Also:
Ref.getObject(), Ref.getObject(Map), [PreparedStatement.setObject(int, Object)](../../../../java/sql/PreparedStatement.html#setObject%28int, java.lang.Object%29), [CallableStatement.setObject(String, Object)](../../../../java/sql/CallableStatement.html#setObject%28java.lang.String, java.lang.Object%29)
Submit a bug or feature
For further API reference and developer documentation, see Java SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2015, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
Scripting on this page tracks web page traffic, but does not change the content in any way.