Modifier and Type	Class and Description
private static class	ProxyGenerator.CacheKey

Modifier and Type	Field and Description
private final LRUCache<ProxyGenerator.CacheKey, ProxyGeneratorAdapter>	adapterCache The adapter cache is used to cache proxy classes.
private boolean	debug
private static final Map<Object, Object>	EMPTY_CLOSURE_MAP
private boolean	emptyMethods
public static final ProxyGenerator	INSTANCE
private ClassLoader	override

Access	Constructor and Description
public	ProxyGenerator()

Method Summary

Modifier and Type	Method and Description
private ProxyGeneratorAdapter	createAdapter(final Map<Object, Object> closureMap, final List<Class<T>> interfaceList, final Class<T> delegateClass, final Class<T> baseClass)
public boolean	getDebug()
public boolean	getEmptyMethods()
public ClassLoader	getOverride()
public GroovyObject	instantiateAggregate(List<Class<T>> interfaces)
public GroovyObject	instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces)
public GroovyObject	instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces, Class<T> clazz)
public GroovyObject	instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces, Class<T> clazz, Object[] constructorArgs)
public GroovyObject	instantiateAggregateFromBaseClass(Class<T> clazz)
public GroovyObject	instantiateAggregateFromBaseClass(Map<K, V> map, Class<T> clazz)
public GroovyObject	instantiateAggregateFromBaseClass(Closure<V> cl, Class<T> clazz)
public GroovyObject	instantiateAggregateFromBaseClass(Class<T> clazz, Object[] constructorArgs)
public GroovyObject	instantiateAggregateFromBaseClass(Map<K, V> map, Class<T> clazz, Object[] constructorArgs)
public GroovyObject	instantiateAggregateFromInterface(Class<T> clazz)
public GroovyObject	instantiateAggregateFromInterface(Map<K, V> map, Class<T> clazz)
public GroovyObject	instantiateDelegate(Object delegate)
public GroovyObject	instantiateDelegate(List<Class<T>> interfaces, Object delegate)
public GroovyObject	instantiateDelegate(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate)
public GroovyObject	instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate)
public GroovyObject	instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate, Class<T> baseClass)
public GroovyObject	Returns: a proxy object implementing the specified interfaces, and delegating to the provided object instantiateDelegateWithBaseClass(Map<K, V> the closure for methods not handled by the delegate closureMap, List<Class<T>> interfaces to be implemented interfaces, Object the delegate object delegate, Class<T> the base class baseClass, String the name of the proxy, unused, but kept for compatibility with previous versions of Groovy. name) Creates a proxy with a delegate object.
public void	setDebug(boolean true if you want generated source to be printed debug) Instructs `ProxyGenerator` to dump generated Groovy source code to standard output during construction.
public void	setEmptyMethods(boolean true if you want generated methods to be empty emptyMethods) Changes generated methods to have empty implementations.
private static void	setMetaClass(final MetaClass metaClass)
public void	setOverride(ClassLoader override)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

adapterCache	back to summary
private final LRUCache<ProxyGenerator.CacheKey, ProxyGeneratorAdapter> adapterCache The adapter cache is used to cache proxy classes. When, for example, a call like: map as MyClass is found, then a lookup is made into the cache to find if a suitable adapter already exists. If so, then the class is reused, instead of generating a new class.

debug	back to summary
private boolean debug

EMPTY_CLOSURE_MAP	back to summary
private static final Map<Object, Object> EMPTY_CLOSURE_MAP

emptyMethods	back to summary
private boolean emptyMethods

INSTANCE	back to summary
public static final ProxyGenerator INSTANCE

override	back to summary
private ClassLoader override

ProxyGenerator	back to summary
public ProxyGenerator()

Method Detail

createAdapter	back to summary
private ProxyGeneratorAdapter createAdapter(final Map<Object, Object> closureMap, final List<Class<T>> interfaceList, final Class<T> delegateClass, final Class<T> baseClass)

getDebug	back to summary
public boolean getDebug()

getEmptyMethods	back to summary
public boolean getEmptyMethods()

getOverride	back to summary
public ClassLoader getOverride()

instantiateAggregate	back to summary
public GroovyObject instantiateAggregate(List<Class<T>> interfaces)

instantiateAggregate	back to summary
public GroovyObject instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces)

instantiateAggregate	back to summary
public GroovyObject instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces, Class<T> clazz)

instantiateAggregate	back to summary
public GroovyObject instantiateAggregate(Map<K, V> closureMap, List<Class<T>> interfaces, Class<T> clazz, Object[] constructorArgs)

instantiateAggregateFromBaseClass	back to summary
public GroovyObject instantiateAggregateFromBaseClass(Class<T> clazz)

instantiateAggregateFromBaseClass	back to summary
public GroovyObject instantiateAggregateFromBaseClass(Map<K, V> map, Class<T> clazz)

instantiateAggregateFromBaseClass	back to summary
public GroovyObject instantiateAggregateFromBaseClass(Closure<V> cl, Class<T> clazz)

instantiateAggregateFromBaseClass	back to summary
public GroovyObject instantiateAggregateFromBaseClass(Class<T> clazz, Object[] constructorArgs)

instantiateAggregateFromBaseClass	back to summary
public GroovyObject instantiateAggregateFromBaseClass(Map<K, V> map, Class<T> clazz, Object[] constructorArgs)

instantiateAggregateFromInterface	back to summary
public GroovyObject instantiateAggregateFromInterface(Class<T> clazz)

instantiateAggregateFromInterface	back to summary
public GroovyObject instantiateAggregateFromInterface(Map<K, V> map, Class<T> clazz)

instantiateDelegate	back to summary
public GroovyObject instantiateDelegate(Object delegate)

instantiateDelegate	back to summary
public GroovyObject instantiateDelegate(List<Class<T>> interfaces, Object delegate)

instantiateDelegate	back to summary
public GroovyObject instantiateDelegate(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate)

instantiateDelegateWithBaseClass	back to summary
public GroovyObject instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate)

instantiateDelegateWithBaseClass	back to summary
public GroovyObject instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate, Class<T> baseClass)

instantiateDelegateWithBaseClass	back to summary
public GroovyObject instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate, Class<T> baseClass, String name) Creates a proxy with a delegate object. Parameters closureMap:Map<K, V> the closure for methods not handled by the delegate interfaces:List<Class<T>> interfaces to be implemented delegate:Object the delegate object baseClass:Class<T> the base class name:String the name of the proxy, unused, but kept for compatibility with previous versions of Groovy. Returns:GroovyObject a proxy object implementing the specified interfaces, and delegating to the provided object

instantiateDelegateWithBaseClass

back to summary

public GroovyObject instantiateDelegateWithBaseClass(Map<K, V> closureMap, List<Class<T>> interfaces, Object delegate, Class<T> baseClass, String name)

Creates a proxy with a delegate object.

Parameters

closureMap:Map<K, V>: the closure for methods not handled by the delegate
interfaces:List<Class<T>>: interfaces to be implemented
delegate:Object: the delegate object
baseClass:Class<T>: the base class
name:String: the name of the proxy, unused, but kept for compatibility with previous versions of Groovy.

Returns:GroovyObject

a proxy object implementing the specified interfaces, and delegating to the provided object

setDebug back to summary

setDebug	back to summary
public void setDebug(boolean debug) Instructs `ProxyGenerator` to dump generated Groovy source code to standard output during construction. This is useful for debugging purposes but should be turned off in production. Parameters debug:boolean true if you want generated source to be printed

public void setDebug(boolean debug)

Instructs ProxyGenerator to dump generated Groovy source code to standard output during construction. This is useful for debugging purposes but should be turned off in production.

Parameters

debug:boolean: true if you want generated source to be printed

setEmptyMethods back to summary

setEmptyMethods	back to summary
public void setEmptyMethods(boolean emptyMethods) Changes generated methods to have empty implementations. Methods in generated aggregates not supplied in a closures map or base class are given 'default' implementations. The implementation will normally throw an `UnsupportedOperationException` but setting this boolean will leave it empty. Parameters emptyMethods:boolean true if you want generated methods to be empty

public void setEmptyMethods(boolean emptyMethods)

Changes generated methods to have empty implementations.

Methods in generated aggregates not supplied in a closures map or base class are given 'default' implementations. The implementation will normally throw an UnsupportedOperationException but setting this boolean will leave it empty.

Parameters

emptyMethods:boolean: true if you want generated methods to be empty

setMetaClass	back to summary
private static void setMetaClass(final MetaClass metaClass)

setOverride	back to summary
public void setOverride(ClassLoader override)

groovy.util back to summary

private final Class ProxyGenerator.CacheKey

Class Inheritance

extends Object

java.lang.Object
groovy.util.ProxyGenerator.CacheKey

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ProxyGenerator.CacheKey.ClassReference A weak reference which delegates equals and hashcode to the referent.

Field Summary

Modifier and Type	Field and Description
private final ProxyGenerator.CacheKey.ClassReference	baseClass
private final ProxyGenerator.CacheKey.ClassReference	delegateClass
private final boolean	emptyMethods
private static final Comparator<Class<T>>	INTERFACE_COMPARATOR
private final ProxyGenerator.CacheKey.ClassReference[]	interfaces
private final Set<String>	methods
private final boolean	useDelegate

Constructor Summary

Access	Constructor and Description
private	CacheKey(final Class<T> baseClass, final Class<T> delegateClass, final Set<String> methods, final Class<T>[] interfaces, final boolean emptyMethods, final boolean useDelegate)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

baseClass	back to summary
private final ProxyGenerator.CacheKey.ClassReference baseClass

delegateClass	back to summary
private final ProxyGenerator.CacheKey.ClassReference delegateClass

emptyMethods	back to summary
private final boolean emptyMethods

INTERFACE_COMPARATOR	back to summary
private static final Comparator<Class<T>> INTERFACE_COMPARATOR

interfaces	back to summary
private final ProxyGenerator.CacheKey.ClassReference[] interfaces

methods	back to summary
private final Set<String> methods

useDelegate	back to summary
private final boolean useDelegate

Constructor Detail

CacheKey	back to summary
private CacheKey(final Class<T> baseClass, final Class<T> delegateClass, final Set<String> methods, final Class<T>[] interfaces, final boolean emptyMethods, final boolean useDelegate)

Method Detail

equals back to summary

equals	back to summary
public boolean equals(final Object o) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

groovy.util back to summary

private Class ProxyGenerator.CacheKey.ClassReference

Class Inheritance

extends WeakReference<Class<T>>

java.lang.Object
java.lang.ref.Reference
java.lang.ref.WeakReference
groovy.util.ProxyGenerator.CacheKey.ClassReference

A weak reference which delegates equals and hashcode to the referent.

Constructor Summary

Access	Constructor and Description
public	ClassReference(Class<T> referent)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(final Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.

Constructor Detail

ClassReference	back to summary
public ClassReference(Class<T> referent)

Method Detail

equals back to summary

public boolean equals(final Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object.

Annotations

@Override

public Class ProxyGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class ProxyGenerator.CacheKey

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ProxyGenerator.CacheKey.ClassReference

Constructor Summary

Method Summary

Constructor Detail

Method Detail