oracle.sql
Class OpaqueDescriptor

java.lang.Object
  |
  +--oracle.sql.TypeDescriptor
        |
        +--oracle.sql.OpaqueDescriptor

public class OpaqueDescriptor
extends TypeDescriptor
implements java.io.Serializable

See Also:
Serialized Form

Fields inherited from class oracle.sql.TypeDescriptor
DEBUG_SERIALIZATION
 
Constructor Summary
OpaqueDescriptor(oracle.sql.SQLName name, oracle.sql.OracleTypeOPAQUE type, java.sql.Connection connection)
          (INTERNAL) Constructor.
 
Method Summary
static OpaqueDescriptor createDescriptor(java.lang.String name, java.sql.Connection conn)
          Descriptor factory.
 java.lang.String descType()
          Describe this 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
getName, getSubtypeName, setConnection
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OpaqueDescriptor

public OpaqueDescriptor(oracle.sql.SQLName name,
                        oracle.sql.OracleTypeOPAQUE type,
                        java.sql.Connection connection)
                 throws java.sql.SQLException
(INTERNAL) Constructor. Create a brand new OpaqueDescriptor.
Parameters:
name - the String that names the type (fully qualified name).
OracleConnection - the connection to the data base to locate the type.
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)
connection - a Connection to a database

getTypeCode

public int getTypeCode()
Return the Opaque type code: OracleTypes.OPAQUE.

getMaxLength

public long getMaxLength()
                  throws java.sql.SQLException
Return the maximun number of bytes this opaque object can hold.
Returns:
the maximum opaque size; return 0 if unbounded.
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.
Returns:
true if the Trusted Library implementing Support functions are specified; false, otherwise.
Since:
8.2.0

isModeledInC

public boolean isModeledInC()
                     throws java.sql.SQLException
Indicates whether the Opaque type is modelled in C language.
Returns:
true if the Opaque type is modelled in C language; false, otherwise.
Since:
8.2.0

hasUnboundedSize

public boolean hasUnboundedSize()
                         throws java.sql.SQLException
Indicates whether the Opaque type has unbounded size ().
Returns:
true if the Opaque type hsa unbounded size; false, otherwise.
Since:
8.2.0

hasFixedSize

public boolean hasFixedSize()
                     throws java.sql.SQLException
Indicates whether the Opaque type has fixed size.
Returns:
true if the Opaque type has fixed size; false, otherwise.
Since:
8.2.0

descType

public java.lang.String descType()
                          throws java.sql.SQLException
Describe this type.
Returns:
the type information.