Top Description Fields Constructors Methods
org.hibernate.engine.jdbc

public Class ClobProxy

extends Object
implements InvocationHandler
Class Inheritance
All Implemented Interfaces
java.lang.reflect.InvocationHandler
Known Direct Subclasses
org.hibernate.engine.jdbc.NClobProxy
Imports
java.io.IOException, .InputStream, .Reader, java.lang.reflect.InvocationHandler, .Method, .Proxy, java.sql.Clob, .SQLException, org.hibernate.engine.jdbc.internal.CharacterStreamImpl, org.hibernate.type.descriptor.java.DataHelper

Manages aspects of proxying Clobs for non-contextual creation, including proxy creation and handling proxy invocations. We use proxies here solely to avoid JDBC version incompatibilities.
Authors
Gavin King, Steve Ebersole, Gail Badner

Field Summary

Modifier and TypeField and Description
private final CharacterStream
private boolean
private static final Class<T>[]

Constructor Summary

AccessConstructor and Description
protected
ClobProxy(String
The byte array
string
)

Constructor used to build Clob from string data.

protected
ClobProxy(Reader
The character reader.
reader
,
long
The length of the reader stream.
length
)

Constructor used to build Clob from a reader.

Method Summary

Modifier and TypeMethod and Description
public static Clob

Returns:

The generated proxy.
generateProxy
(String
The data to be wrapped as a Clob.
string
)

Generates a Clob proxy using the string data.

public static Clob

Returns:

The generated proxy.
generateProxy
(Reader
The character reader
reader
,
long
The length of the character reader
length
)

Generates a Clob proxy using a character reader of given length.

protected InputStream
protected Reader
protected long
protected static ClassLoader

Returns:

The class loader appropriate for proxy construction.
getProxyClassLoader
()

Determines the appropriate class loader to which the generated proxy should be scoped.

protected String
getSubString(long start, int length)

protected CharacterStream
public Object
invoke(Object
the proxy instance that the method was invoked on
proxy
,
Method
the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.
method
,
Object[]
an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.
args
)

Implements java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result.
protected void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

characterStreamback to summary
private final CharacterStream characterStream
needsResetback to summary
private boolean needsReset
PROXY_INTERFACESback to summary
private static final Class<T>[] PROXY_INTERFACES

Constructor Detail

ClobProxyback to summary
protected ClobProxy(String string)

Constructor used to build Clob from string data.

Parameters
string:String

The byte array

See Also
generateProxy(String)
ClobProxyback to summary
protected ClobProxy(Reader reader, long length)

Constructor used to build Clob from a reader.

Parameters
reader:Reader

The character reader.

length:long

The length of the reader stream.

See Also
generateProxy(java.io.Reader, long)

Method Detail

generateProxyback to summary
public static Clob generateProxy(String string)

Generates a Clob proxy using the string data.

Parameters
string:String

The data to be wrapped as a Clob.

Returns:Clob

The generated proxy.

generateProxyback to summary
public static Clob generateProxy(Reader reader, long length)

Generates a Clob proxy using a character reader of given length.

Parameters
reader:Reader

The character reader

length:long

The length of the character reader

Returns:Clob

The generated proxy.

getAsciiStreamback to summary
protected InputStream getAsciiStream() throws SQLException
getCharacterStreamback to summary
protected Reader getCharacterStream() throws SQLException
getLengthback to summary
protected long getLength()
getProxyClassLoaderback to summary
protected static ClassLoader getProxyClassLoader()

Determines the appropriate class loader to which the generated proxy should be scoped.

Returns:ClassLoader

The class loader appropriate for proxy construction.

getSubStringback to summary
protected String getSubString(long start, int length)
getUnderlyingStreamback to summary
protected CharacterStream getUnderlyingStream() throws SQLException
invokeback to summary
public Object invoke(Object proxy, Method method, Object[] args) throws Throwable

Implements java.lang.reflect.InvocationHandler.invoke.

Doc from java.lang.reflect.InvocationHandler.invoke.

Processes a method invocation on a proxy instance and returns the result. This method will be invoked on an invocation handler when a method is invoked on a proxy instance that it is associated with.

Parameters
proxy:Object

the proxy instance that the method was invoked on

method:Method

the Method instance corresponding to the interface method invoked on the proxy instance. The declaring class of the Method object will be the interface that the method was declared in, which may be a superinterface of the proxy interface that the proxy class inherits the method through.

args:Object[]

an array of objects containing the values of the arguments passed in the method invocation on the proxy instance, or null if interface method takes no arguments. Arguments of primitive types are wrapped in instances of the appropriate primitive wrapper class, such as java.lang.Integer or java.lang.Boolean.

Returns:Object

the value to return from the method invocation on the proxy instance. If the declared return type of the interface method is a primitive type, then the value returned by this method must be an instance of the corresponding primitive wrapper class; otherwise, it must be a type assignable to the declared return type. If the value returned by this method is null and the interface method's return type is primitive, then a NullPointerException will be thrown by the method invocation on the proxy instance. If the value returned by this method is otherwise not compatible with the interface method's declared return type as described above, a ClassCastException will be thrown by the method invocation on the proxy instance.

Annotations
@Override
Exceptions
Throwable:
the exception to throw from the method invocation on the proxy instance. The exception's type must be assignable either to any of the exception types declared in the throws clause of the interface method or to the unchecked exception types java.lang.RuntimeException or java.lang.Error. If a checked exception is thrown by this method that is not assignable to any of the exception types declared in the throws clause of the interface method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.
UnsupportedOperationException:
if any methods other than Clob#length, Clob#getAsciiStream, Clob#getCharacterStream, ClobImplementer#getUnderlyingStream, Clob#getSubString, Clob#free, or toString/equals/hashCode are invoked.
resetIfNeededback to summary
protected void resetIfNeeded() throws SQLException