com.goldencode.proxy

Class ProxyFactory.CacheKey

java.lang.Object

com.goldencode.proxy.ProxyFactory.CacheKey

Enclosing class:

ProxyFactory

public static class ProxyFactory.CacheKey
extends java.lang.Object

A cache key which takes into account a proxy class' parent, implemented interfaces, whether only declared methods are implemented, and list of methods to be omitted from the proxy.

If all the above criteria match between two keys, the keys are equivalent; else they are not.

Instances of this class are used in a cache, to ensure redundant proxy classes are not assembled and loaded. TODO: Since these cache keys rely in part on the proxies' parent classes and interfaces, their presence in the cache will prevent these parent classes and interfaces from being unloaded and garbage collected. This constitutes a potential memory leak, which should be resolved.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	declaredOnly Flag indicating only declared methods of interfaces are proxied
private static java.util.Map<java.lang.Object,java.lang.Integer>	DO_NOT_PROXY_HASH_CODES Hash code for the doNotProxy arrays.
private java.lang.reflect.Method[]	doNotProxy Methods which are not to be proxied
private int	hashCode Hash code for this key
private java.lang.Class<?>[]	interfaces Interfaces implemented by proxy class
private java.lang.Class<?>	parent Parent class of proxy class

Constructor Summary

Constructors

Constructor and Description
CacheKey(java.lang.Class<?> parent, java.lang.Class<?>[] interfaces, boolean declaredOnly, java.lang.reflect.Method[] doNotProxy) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Determine whether this object is equivalent to the given object.
int	hashCode() Return a well-distributed hash code which is consistent with this class' implementation of equals(Object).
java.lang.String	toString() Method used to create a string representation of ProxyFactory.CacheKey, which is also used for mapping to names of pre-generated Proxy classes.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DO_NOT_PROXY_HASH_CODES

private static final java.util.Map<java.lang.Object,java.lang.Integer> DO_NOT_PROXY_HASH_CODES

Hash code for the doNotProxy arrays.

parent

private final java.lang.Class<?> parent

Parent class of proxy class

interfaces

private final java.lang.Class<?>[] interfaces

Interfaces implemented by proxy class

declaredOnly

private final boolean declaredOnly

Flag indicating only declared methods of interfaces are proxied

doNotProxy

private final java.lang.reflect.Method[] doNotProxy

Methods which are not to be proxied

hashCode

private final int hashCode

Hash code for this key

Constructor Detail

CacheKey

public CacheKey(java.lang.Class<?> parent,
                java.lang.Class<?>[] interfaces,
                boolean declaredOnly,
                java.lang.reflect.Method[] doNotProxy)

Constructor.

Parameters:

parent - Parent class of proxy class.

interfaces - Interfaces implemented by proxy class.

declaredOnly - Flag indicating only declared methods of interfaces are proxied.

doNotProxy - Methods which are not to be proxied. May be an empty array, but must not be null.

Method Detail

hashCode

public int hashCode()

Return a well-distributed hash code which is consistent with this class' implementation of equals(Object).

Overrides:

hashCode in class java.lang.Object

Returns:

Hash code.

equals

public boolean equals(java.lang.Object o)

Determine whether this object is equivalent to the given object.

Two cache keys are considered equivalent if their various fields are equivalent.

Overrides:

equals in class java.lang.Object

Parameters:

o - Another object to test for equivalence with this one.

Returns:

true if o is another instance of this class with equivalent fields, else false.

toString

public java.lang.String toString()

Method used to create a string representation of ProxyFactory.CacheKey, which is also used for mapping to names of pre-generated Proxy classes. So there should be a balance in how unique this methods result is, and how efficient this method is.

Overrides:

toString in class java.lang.Object