oracle.sql

Class OPAQUE

java.lang.Object

oracle.sql.Datum

oracle.sql.DatumWithConnection

oracle.sql.OPAQUE

All Implemented Interfaces:

Serializable, oracle.jdbc.internal.ACProxyable, oracle.jdbc.internal.OracleDatumWithConnection, OracleOpaque

Deprecated.

Use oracle.jdbc.OracleOpaque interface for declaration instead of using concrete class oracle.sql.OPAQUE.

public class OPAQUE
extends DatumWithConnection
implements oracle.jdbc.internal.OracleOpaque

A class for opaque data type. Use OracleOpaque interface for declaration instead of using concrete class oracle.sql.OPAQUE. oracle.jdbc.OracleOpaque has methods declared for all opertions.

Obtaining an OracleOpaque from OracleResultSet

oracle.jdbc.OracleOpaque opaque = ((OracleResultSet)resultSet).getOPAQUE(...);

Since:

8.2

See Also:

OracleOpaque, Serialized Form

Constructor Summary

Constructors

Constructor and Description
OPAQUE(OpaqueDescriptor type, Connection conn, Object value) Deprecated. Constructor.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytesValue() Deprecated. Return a byte array that represents the attributes into the format that is actually used in the database.
OpaqueDescriptor	getDescriptor() Deprecated. Oracle extension.
Connection	getJavaSqlConnection() Deprecated. Oracle extension Return the java.sql.Connection associated with the receiver.
OracleTypeMetaData	getOracleMetaData() Deprecated. Return the type data for this object
String	getSQLTypeName() Deprecated. Implements the Struct interface function Retrieves the SQL type name of the SQL structured type that this Struct object represents.
Object	getValue() Deprecated. Return the Opaque value.
boolean	isConvertibleTo(Class jClass) Deprecated. Determines if datum object can be converted to a particular class
String	stringValue() Deprecated. Convert to a String representation of the datum object
Object	toJdbc() Deprecated. Returns the JDBC representation of the datum object

Methods inherited from class oracle.sql.DatumWithConnection

assertNotNull, assertNotNull, getConnection, getConnectionDuringExceptionHandling, getOracleConnection

Methods inherited from class oracle.sql.Datum

asciiStreamValue, bigDecimalValue, binaryStreamValue, booleanValue, bytesEqual, bytesHashCode, byteValue, characterStreamValue, compareBytes, dateValue, doubleValue, equals, floatValue, getBytes, getLength, getStream, intValue, isNull, longValue, setBytes, setShareBytes, shareBytes, stringValue, timestampValue, timestampValue, timeValue, timeValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jdbc.internal.OracleDatumWithConnection

asciiStreamValue, bigDecimalValue, binaryStreamValue, booleanValue, byteValue, characterStreamValue, dateValue, doubleValue, floatValue, getBytes, getConnection, getInternalConnection, getLength, getOracleConnection, getStream, intValue, longValue, setBytes, setPhysicalConnectionOf, setShareBytes, shareBytes, stringValue, timestampValue, timestampValue, timeValue, timeValue

Constructor Detail

OPAQUE

public OPAQUE(OpaqueDescriptor type,
              Connection conn,
              Object value)
       throws SQLException

Deprecated.

Constructor. The raw bytes are computed at this time or a copy of attributes is made. In any event the caller is free to modify the array without affecting the values held in the OPAQUE.

Parameters:

type - the SQLStructType used to convert the type to

attributes - the array specifying the attributes to be converted to raw bytes.

Throws:

SQLException

See Also:

oracle.sql.SQLStructType

Method Detail

getSQLTypeName

public String getSQLTypeName()
                      throws SQLException

Deprecated.

Implements the Struct interface function Retrieves the SQL type name of the SQL structured type that this Struct object represents.

Specified by:

getSQLTypeName in interface OracleOpaque

Returns:

the fully-qualified type name of the SQL structured type for which this Struct object is the generic representation

Throws:

SQLException - if a database access error occurs

stringValue

public String stringValue()
                   throws SQLException

Deprecated.

Description copied from class: Datum

Convert to a String representation of the datum object

Specified by:

stringValue in interface oracle.jdbc.internal.OracleDatumWithConnection

Overrides:

stringValue in class Datum

Returns:

String representation of the datum object

Throws:

SQLException

getOracleMetaData

public OracleTypeMetaData getOracleMetaData()
                                     throws SQLException

Deprecated.

Return the type data for this object

Specified by:

getOracleMetaData in interface OracleOpaque

Returns:

type metadata

Throws:

SQLException - if an error occurs

Since:

11.2.0.3.0

getDescriptor

public OpaqueDescriptor getDescriptor()
                               throws SQLException

Deprecated.

Oracle extension. Return the OpaqueDescriptor object that contains the type information.

Returns:

the type descriptor

Throws:

SQLException

getValue

public Object getValue()
                throws SQLException

Deprecated.

Return the Opaque value.

Specified by:

getValue in interface OracleOpaque

Returns:

a Java object that represents the opaque value

Throws:

SQLException

getBytesValue

public byte[] getBytesValue()
                     throws SQLException

Deprecated.

Return a byte array that represents the attributes into the format that is actually used in the database.

Returns:

a byte array that represents the opaque value

Throws:

SQLException

isConvertibleTo

public boolean isConvertibleTo(Class jClass)

Deprecated.

Determines if datum object can be converted to a particular class

Specified by:

isConvertibleTo in interface oracle.jdbc.internal.OracleDatumWithConnection

Specified by:

isConvertibleTo in class Datum

Parameters:

cls - Class to convert to

Returns:

true, if conversion to cls is permitted false, if conversion to cls is not permitted

toJdbc

public Object toJdbc()
              throws SQLException

Deprecated.

Returns the JDBC representation of the datum object

Specified by:

toJdbc in interface oracle.jdbc.internal.OracleDatumWithConnection

Specified by:

toJdbc in class Datum

Returns:

an object containing the JDBC value

Throws:

SQLException - if conversion to JDBC representation results in an error

getJavaSqlConnection

public Connection getJavaSqlConnection()
                                throws SQLException

Deprecated.

Description copied from class: DatumWithConnection

Oracle extension Return the java.sql.Connection associated with the receiver. Since 9.0.0 not all Oracle JDBC connection objects are assignment compatible with oracle.jdbc.driver.OracleConnection. If the connection is wrapped, return the outermost wrapper.

Specified by:

getJavaSqlConnection in interface oracle.jdbc.internal.OracleDatumWithConnection

Overrides:

getJavaSqlConnection in class DatumWithConnection

Returns:

the connection

Throws:

SQLException - if an error occurs