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

public Class BlobProxy

extends Object
implements InvocationHandler
Class Inheritance
All Implemented Interfaces
java.lang.reflect.InvocationHandler
Imports
java.lang.reflect.InvocationHandler, .Method, .Proxy, java.sql.Blob, .SQLException, java.io.InputStream, .IOException, org.hibernate.type.descriptor.java.BinaryStreamImpl, .DataHelper

Manages aspects of proxying Blobs for non-contextual creation, including proxy creation and handling proxy invocations.
Authors
Gavin King, Steve Ebersole, Gail Badner

Field Summary

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

Constructor Summary

AccessConstructor and Description
private
BlobProxy(byte[]
The byte array
bytes
)

Constructor used to build Blob from byte array.

private
BlobProxy(InputStream
The binary stream
stream
,
long
The length of the stream
length
)

Constructor used to build Blob from a stream.

Method Summary

Modifier and TypeMethod and Description
public static Blob

Returns:

The generated proxy.
generateProxy
(byte[]
The data to be created as a Blob.
bytes
)

Generates a BlobImpl proxy using byte data.

public static Blob

Returns:

The generated proxy.
generateProxy
(InputStream
The input stream of bytes to be created as a Blob.
stream
,
long
The number of bytes from stream to be written to the Blob.
length
)

Generates a BlobImpl proxy using a given number of bytes from an InputStream.

private long
private static ClassLoader

Returns:

The class loader appropriate for proxy construction.
getProxyClassLoader
()

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

private InputStream
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.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

lengthback to summary
private long length
needsResetback to summary
private boolean needsReset
PROXY_INTERFACESback to summary
private static final Class<T>[] PROXY_INTERFACES
streamback to summary
private InputStream stream

Constructor Detail

BlobProxyback to summary
private BlobProxy(byte[] bytes)

Constructor used to build Blob from byte array.

Parameters
bytes:byte[]

The byte array

See Also
generateProxy(byte[])
BlobProxyback to summary
private BlobProxy(InputStream stream, long length)

Constructor used to build Blob from a stream.

Parameters
stream:InputStream

The binary stream

length:long

The length of the stream

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

Method Detail

generateProxyback to summary
public static Blob generateProxy(byte[] bytes)

Generates a BlobImpl proxy using byte data.

Parameters
bytes:byte[]

The data to be created as a Blob.

Returns:Blob

The generated proxy.

generateProxyback to summary
public static Blob generateProxy(InputStream stream, long length)

Generates a BlobImpl proxy using a given number of bytes from an InputStream.

Parameters
stream:InputStream

The input stream of bytes to be created as a Blob.

length:long

The number of bytes from stream to be written to the Blob.

Returns:Blob

The generated proxy.

getLengthback to summary
private long getLength()
getProxyClassLoaderback to summary
private 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.

getStreamback to summary
private InputStream getStream() 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
@SuppressWarnings:UnnecessaryBoxing
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 Blob#length() or Blob#getBinaryStream are invoked.