APIdia Launch Partner
Top Description Fields Constructors Methods
javax.management.openmbean

public Class CompositeDataInvocationHandler

extends Object
implements InvocationHandler
Class Inheritance
All Implemented Interfaces
java.lang.reflect.InvocationHandler
Imports
com.sun.jmx.mbeanserver.MXBeanLookup, .MXBeanMapping, .MXBeanMappingFactory, .DefaultMXBeanMappingFactory, java.lang.reflect.InvocationHandler, .Method, .Proxy

An InvocationHandler that forwards getter methods to a CompositeData. If you have an interface that contains only getter methods (such as String getName() or boolean isActive()) then you can use this class in conjunction with the Proxy class to produce an implementation of the interface where each getter returns the value of the corresponding item in a CompositeData.

For example, suppose you have an interface like this:

public interface NamedNumber {
    public int getNumber();
    public String getName();
}
and a CompositeData constructed like this:
CompositeData cd =
    new CompositeDataSupport(
        someCompositeType,
        new String[] {"number", "name"},
        new Object[] {5, "five"}
    );
then you can construct an object implementing NamedNumber and backed by the object cd like this:
InvocationHandler handler =
    new CompositeDataInvocationHandler(cd);
NamedNumber nn = (NamedNumber)
    Proxy.newProxyInstance(NamedNumber.class.getClassLoader(),
                           new Class[] {NamedNumber.class},
                           handler);
A call to nn.getNumber() will then return 5.

If the first letter of the property defined by a getter is a capital, then this handler will look first for an item in the CompositeData beginning with a capital, then, if that is not found, for an item beginning with the corresponding lowercase letter or code point. For a getter called getNumber(), the handler will first look for an item called Number, then for number. If the getter is called getnumber(), then the item must be called number.

If the method given to invoke is the method boolean equals(Object) inherited from Object, then it will return true if and only if the argument is a Proxy whose InvocationHandler is also a CompositeDataInvocationHandler and whose backing CompositeData is equal (not necessarily identical) to this object's. If the method given to invoke is the method int hashCode() inherited from Object, then it will return a value that is consistent with this definition of equals: if two objects are equal according to equals, then they will have the same hashCode.

Since
1.6

Field Summary

Modifier and TypeField and Description
private final CompositeData
private final MXBeanLookup

Constructor Summary

AccessConstructor and Description
public
CompositeDataInvocationHandler(CompositeData
the CompositeData that will supply information to getters.
compositeData
)

Construct a handler backed by the given CompositeData.

pack-priv
CompositeDataInvocationHandler(CompositeData
the CompositeData that will supply information to getters.
compositeData
,
MXBeanLookup lookup)

Construct a handler backed by the given CompositeData.

Method Summary

Modifier and TypeMethod and Description
private boolean
equals(Object proxy, Object other)

public CompositeData

Returns:

the CompositeData that this handler is backed by. This is never null.
getCompositeData
()

Return the CompositeData that was supplied to the constructor.

public Object
invoke(Object proxy, Method method, Object[] 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

compositeDataback to summary
private final CompositeData compositeData
lookupback to summary
private final MXBeanLookup lookup

Constructor Detail

CompositeDataInvocationHandlerback to summary
public CompositeDataInvocationHandler(CompositeData compositeData)

Construct a handler backed by the given CompositeData.

Parameters
compositeData:CompositeData

the CompositeData that will supply information to getters.

Exceptions
IllegalArgumentException:
if compositeData is null.
CompositeDataInvocationHandlerback to summary
pack-priv CompositeDataInvocationHandler(CompositeData compositeData, MXBeanLookup lookup)

Construct a handler backed by the given CompositeData.

Parameters
compositeData:CompositeData

the CompositeData that will supply information to getters.

Exceptions
IllegalArgumentException:
if compositeData is null.

Method Detail

equalsback to summary
private boolean equals(Object proxy, Object other)
getCompositeDataback to summary
public CompositeData getCompositeData()

Return the CompositeData that was supplied to the constructor.

Returns:CompositeData

the CompositeData that this handler is backed by. This is never null.

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.

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 invoked 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 invoked method, then an UndeclaredThrowableException containing the exception that was thrown by this method will be thrown by the method invocation on the proxy instance.