oracle.sql
Class OpaqueDescriptor

java.lang.Object
  oracle.sql.TypeDescriptor
      oracle.sql.OpaqueDescriptor

All Implemented Interfaces:

java.io.Serializable, oracle.jdbc.internal.ObjectData, OracleData, OracleTypeMetaData, OracleTypeMetaData.Opaque, ORAData

public class OpaqueDescriptor
extends TypeDescriptor
implements OracleTypeMetaData.Opaque, java.io.Serializable

Type descriptor of Opaque data type.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.jdbc.OracleTypeMetaData

OracleTypeMetaData.Array, OracleTypeMetaData.ArrayStorage, OracleTypeMetaData.Kind, OracleTypeMetaData.Opaque, OracleTypeMetaData.Struct

Field Summary

static java.lang.String	BUILD_DATE
static boolean	TRACE

Fields inherited from class oracle.sql.TypeDescriptor

ANYDATASETTOID, ANYDATATOID, ANYTYPETOID, DEBUG_SERIALIZATION, RAWTOID, TYPECODE_BDOUBLE, TYPECODE_BFILE, TYPECODE_BFLOAT, TYPECODE_BLOB, TYPECODE_BOOLEAN, TYPECODE_CFILE, TYPECODE_CHAR, TYPECODE_CLOB, TYPECODE_DATE, TYPECODE_DECIMAL, TYPECODE_DOUBLE, TYPECODE_ERRHP, TYPECODE_FLOAT, TYPECODE_INTEGER, TYPECODE_INTERVAL_DS, TYPECODE_INTERVAL_YM, TYPECODE_ITABLE, TYPECODE_JDBC_ARRAY, TYPECODE_JDBC_JOBJECT, TYPECODE_JDBC_JOPAQUE, TYPECODE_JDBC_JSTRUCT, TYPECODE_JDBC_REF, TYPECODE_JDBC_STRUCT, TYPECODE_MLSLABEL, TYPECODE_NAMEDCOLLECTION, TYPECODE_NCHAR, TYPECODE_NCLOB, TYPECODE_NONE, TYPECODE_NUMBER, TYPECODE_NVARCHAR2, TYPECODE_OBJECT, TYPECODE_OCTET, TYPECODE_OPAQUE, TYPECODE_OTMFIRST, TYPECODE_OTMLAST, TYPECODE_PLS_INTEGER, TYPECODE_PTR, TYPECODE_RAW, TYPECODE_REAL, TYPECODE_RECORD, TYPECODE_REF, TYPECODE_SIGNED16, TYPECODE_SIGNED32, TYPECODE_SIGNED8, TYPECODE_SMALLINT, TYPECODE_SYSFIRST, TYPECODE_SYSLAST, TYPECODE_TABLE, TYPECODE_TIME, TYPECODE_TIME_TZ, TYPECODE_TIMESTAMP, TYPECODE_TIMESTAMP_LTZ, TYPECODE_TIMESTAMP_TZ, TYPECODE_UNSIGNED16, TYPECODE_UNSIGNED32, TYPECODE_UNSIGNED8, TYPECODE_UROWID, TYPECODE_VARCHAR, TYPECODE_VARCHAR2, TYPECODE_VARRAY, XMLTYPETOID

Method Summary

static OpaqueDescriptor	createDescriptor(oracle.sql.SQLName sqlName, java.sql.Connection conn) Descriptor factory.
static OpaqueDescriptor	createDescriptor(java.lang.String name, java.sql.Connection conn) Descriptor factory.
java.lang.String	descType() Describe this type.
OracleTypeMetaData.Kind	getKind() Return the kind of type.
long	getMaxLength() Return the maximun number of bytes this opaque object can hold.
int	getTypeCode() Return the Opaque type code: OracleTypes.OPAQUE.
boolean	hasFixedSize() Indicates whether the Opaque type has fixed size.
boolean	hasUnboundedSize() Indicates whether the Opaque type has unbounded size ().
boolean	isModeledInC() Indicates whether the Opaque type is modelled in C language.
boolean	isTrustedLibrary() Indicates whether the Trusted Library implementing Support functions are specified for the Opaque type.

Methods inherited from class oracle.sql.TypeDescriptor

getInternalTypeCode, getName, getPrecision, getScale, getSubtypeName, getTypeCodeName, initMetadataRecursively, initNamesRecursively, isTransient, printXML, printXML, setConnection, setPrecision, setScale, toDatum, toJDBCObject, toXMLString, toXMLString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface oracle.jdbc.OracleTypeMetaData

getName, getSchemaName, getSQLName, getTypeCodeName

Field Detail

BUILD_DATE

public static final java.lang.String BUILD_DATE

See Also:

Constant Field Values

TRACE

public static final boolean TRACE

See Also:

Constant Field Values

Method Detail

createDescriptor

public static OpaqueDescriptor createDescriptor(java.lang.String name,
                                                java.sql.Connection conn)
                                         throws java.sql.SQLException

Descriptor factory. Lookup the name in the database, and determine the characteristics of this array.

Parameters:

name - a String naming the type. (Not necessarily fully qualified)

conn - a Connection to a database

Throws:

java.sql.SQLException

createDescriptor

public static OpaqueDescriptor createDescriptor(oracle.sql.SQLName sqlName,
                                                java.sql.Connection conn)
                                         throws java.sql.SQLException

Descriptor factory. Lookup the name in the database, and determine the characteristics of this array.

Parameters:

name - a SQLName

connection - a Connection to a database

Throws:

java.sql.SQLException

getKind

public OracleTypeMetaData.Kind getKind()

Description copied from interface: OracleTypeMetaData

Return the kind of type.

Specified by:

getKind in interface OracleTypeMetaData

Overrides:

getKind in class TypeDescriptor

Returns:

the kind, OPAQUE

getTypeCode

public int getTypeCode()
                throws java.sql.SQLException

Return the Opaque type code: OracleTypes.OPAQUE.

Specified by:

getTypeCode in interface OracleTypeMetaData

Overrides:

getTypeCode in class TypeDescriptor

Throws:

java.sql.SQLException

getMaxLength

public long getMaxLength()
                  throws java.sql.SQLException

Return the maximun number of bytes this opaque object can hold.

Specified by:

getMaxLength in interface OracleTypeMetaData.Opaque

Returns:

the maximum opaque size; return 0 if unbounded.

Throws:

java.sql.SQLException

Since:

8.2.0

isTrustedLibrary

public boolean isTrustedLibrary()
                         throws java.sql.SQLException

Indicates whether the Trusted Library implementing Support functions are specified for the Opaque type. This is the case for internal Opaque Types that are modeled in C.

Specified by:

isTrustedLibrary in interface OracleTypeMetaData.Opaque

Returns:

true if the Trusted Library implementing Support functions are specified; false, otherwise.

Throws:

java.sql.SQLException

Since:

8.2.0

isModeledInC

public boolean isModeledInC()
                     throws java.sql.SQLException

Indicates whether the Opaque type is modelled in C language.

Specified by:

isModeledInC in interface OracleTypeMetaData.Opaque

Returns:

true if the Opaque type is modelled in C language; false, otherwise.

Throws:

java.sql.SQLException

Since:

8.2.0

hasUnboundedSize

public boolean hasUnboundedSize()
                         throws java.sql.SQLException

Indicates whether the Opaque type has unbounded size ().

Specified by:

hasUnboundedSize in interface OracleTypeMetaData.Opaque

Returns:

true if the Opaque type hsa unbounded size; false, otherwise.

Throws:

java.sql.SQLException

Since:

8.2.0

hasFixedSize

public boolean hasFixedSize()
                     throws java.sql.SQLException

Indicates whether the Opaque type has fixed size.

Specified by:

hasFixedSize in interface OracleTypeMetaData.Opaque

Returns:

true if the Opaque type has fixed size; false, otherwise.

Throws:

java.sql.SQLException

Since:

8.2.0

descType

public java.lang.String descType()
                          throws java.sql.SQLException

Describe this type.

Returns:

the type information.

Throws:

java.sql.SQLException