Modifier and Type	Class and Description
protected static class	AbstractClassGenerator.ClassLoaderData
protected static class	AbstractClassGenerator.Source

Field Summary

Modifier and Type	Field and Description
private boolean	attemptLoad
private static volatile Map<ClassLoader, AbstractClassGenerator.ClassLoaderData>	CACHE
private ClassLoader	classLoader
private String	className
private Class<T>	contextClass
private static final ThreadLocal<T>	CURRENT
private static final boolean	DEFAULT_USE_CACHE
private static final boolean	inNativeImage
private Object	key
private String	namePrefix
private NamingPolicy	namingPolicy
private AbstractClassGenerator.Source	source
private GeneratorStrategy	strategy
private boolean	useCache

Constructor Summary

Access	Constructor and Description
protected	AbstractClassGenerator(AbstractClassGenerator.Source source)

Method Summary

Modifier and Type	Method and Description
protected Object	create(Object key)
protected abstract Object	firstInstance(Class<T> type)
protected Class<T>	generate(AbstractClassGenerator.ClassLoaderData data)
private String	generateClassName(Predicate nameTestPredicate)
public boolean	getAttemptLoad()
public ClassLoader	getClassLoader()
protected final String	getClassName()
public static AbstractClassGenerator<T>	getCurrent() Used internally by CGLIB.
protected abstract ClassLoader	getDefaultClassLoader()
public NamingPolicy	getNamingPolicy()
protected ProtectionDomain	Returns: the protection domain (`null` for using a default) getProtectionDomain() Returns the protection domain to use when defining the class.
public GeneratorStrategy	getStrategy()
public boolean	getUseCache()
protected abstract Object	nextInstance(Object instance)
public void	setAttemptLoad(boolean attemptLoad) If set, CGLIB will attempt to load classes from the specified `ClassLoader` before generating them.
public void	setClassLoader(ClassLoader the loader to generate the new class with, or null to use the default classLoader) Set the `ClassLoader` in which the class will be generated.
private void	setClassName(String className)
public void	setContextClass(Class<T> contextClass)
protected void	setNamePrefix(String namePrefix)
public void	setNamingPolicy(NamingPolicy the custom policy, or null to use the default namingPolicy) Override the default naming policy.
public void	setStrategy(GeneratorStrategy strategy) Set the strategy to use to create the bytecode from this generator.
public void	setUseCache(boolean useCache) Whether use and update the static cache of generated classes for a class with the same properties.
protected Object	unwrapCachedValue(T cached)
protected T	wrapCachedClass(Class<T> klass)

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

Field Detail

attemptLoad	back to summary
private boolean attemptLoad

CACHE	back to summary
private static volatile Map<ClassLoader, AbstractClassGenerator.ClassLoaderData> CACHE

classLoader	back to summary
private ClassLoader classLoader

className	back to summary
private String className

contextClass	back to summary
private Class<T> contextClass

CURRENT	back to summary
private static final ThreadLocal<T> CURRENT

DEFAULT_USE_CACHE	back to summary
private static final boolean DEFAULT_USE_CACHE

inNativeImage	back to summary
private static final boolean inNativeImage

key	back to summary
private Object key

namePrefix	back to summary
private String namePrefix

namingPolicy	back to summary
private NamingPolicy namingPolicy

source	back to summary
private AbstractClassGenerator.Source source

strategy	back to summary
private GeneratorStrategy strategy

useCache	back to summary
private boolean useCache

Constructor Detail

AbstractClassGenerator	back to summary
protected AbstractClassGenerator(AbstractClassGenerator.Source source)

Method Detail

create	back to summary
protected Object create(Object key)

firstInstance	back to summary
protected abstract Object firstInstance(Class<T> type) throws Exception

generate	back to summary
protected Class<T> generate(AbstractClassGenerator.ClassLoaderData data)

generateClassName	back to summary
private String generateClassName(Predicate nameTestPredicate)

getAttemptLoad	back to summary
public boolean getAttemptLoad()

getClassLoader	back to summary
public ClassLoader getClassLoader()

getClassName	back to summary
protected final String getClassName()

getCurrent	back to summary
public static AbstractClassGenerator<T> getCurrent() Used internally by CGLIB. Returns the `AbstractClassGenerator` that is being used to generate a class in the current thread.

getDefaultClassLoader	back to summary
protected abstract ClassLoader getDefaultClassLoader()

getNamingPolicy	back to summary
public NamingPolicy getNamingPolicy() See Also `setNamingPolicy`

getProtectionDomain back to summary

getProtectionDomain	back to summary
protected ProtectionDomain getProtectionDomain() Returns the protection domain to use when defining the class. Default implementation returns `null` for using a default protection domain. Sub-classes may override to use a more specific protection domain. Returns:ProtectionDomain the protection domain (`null` for using a default)

protected ProtectionDomain getProtectionDomain()

Returns the protection domain to use when defining the class.

Default implementation returns null for using a default protection domain. Sub-classes may override to use a more specific protection domain.

Returns:ProtectionDomain: the protection domain (null for using a default)

getStrategy	back to summary
public GeneratorStrategy getStrategy() See Also `setStrategy`

getUseCache	back to summary
public boolean getUseCache() See Also `setUseCache`

nextInstance	back to summary
protected abstract Object nextInstance(Object instance) throws Exception

setAttemptLoad	back to summary
public void setAttemptLoad(boolean attemptLoad) If set, CGLIB will attempt to load classes from the specified `ClassLoader` before generating them. Because generated class names are not guaranteed to be unique, the default is `false`.

setClassLoader back to summary

setClassLoader	back to summary
public void setClassLoader(ClassLoader classLoader) Set the `ClassLoader` in which the class will be generated. Concrete subclasses of `AbstractClassGenerator` (such as `Enhancer`) will try to choose an appropriate default if this is unset. Classes are cached per-`ClassLoader` using a `WeakHashMap`, to allow the generated classes to be removed when the associated loader is garbage collected. Parameters classLoader:ClassLoader the loader to generate the new class with, or null to use the default

public void setClassLoader(ClassLoader classLoader)

Set the ClassLoader in which the class will be generated. Concrete subclasses of AbstractClassGenerator (such as Enhancer) will try to choose an appropriate default if this is unset.

Classes are cached per-ClassLoader using a WeakHashMap, to allow the generated classes to be removed when the associated loader is garbage collected.

Parameters

classLoader:ClassLoader: the loader to generate the new class with, or null to use the default

setClassName	back to summary
private void setClassName(String className)

setContextClass	back to summary
public void setContextClass(Class<T> contextClass)

setNamePrefix	back to summary
protected void setNamePrefix(String namePrefix)

setNamingPolicy back to summary

setNamingPolicy	back to summary
public void setNamingPolicy(NamingPolicy namingPolicy) Override the default naming policy. Parameters namingPolicy:NamingPolicy the custom policy, or null to use the default See Also `DefaultNamingPolicy`

public void setNamingPolicy(NamingPolicy namingPolicy)

Override the default naming policy.

Parameters

namingPolicy:NamingPolicy: the custom policy, or null to use the default

See Also

DefaultNamingPolicy

setStrategy	back to summary
public void setStrategy(GeneratorStrategy strategy) Set the strategy to use to create the bytecode from this generator. By default an instance of `DefaultGeneratorStrategy` is used.

setUseCache	back to summary
public void setUseCache(boolean useCache) Whether use and update the static cache of generated classes for a class with the same properties. Default is `true`.

unwrapCachedValue	back to summary
protected Object unwrapCachedValue(T cached)

wrapCachedClass	back to summary
protected T wrapCachedClass(Class<T> klass)

org.springframework.cglib.core back to summary

protected Class AbstractClassGenerator.ClassLoaderData

Class Inheritance

extends Object

java.lang.Object
org.springframework.cglib.core.AbstractClassGenerator.ClassLoaderData

Field Summary

Modifier and Type	Field and Description
private final WeakReference<ClassLoader>	classLoader Note ClassLoaderData object is stored as a value of `WeakHashMap<ClassLoader, ...`
private final LoadingCache<AbstractClassGenerator<T>, Object, Object>	generatedClasses `AbstractClassGenerator` here holds "cache key" (e.g. `org.springframework.cglib.proxy.Enhancer` configuration), and the value is the generated class plus some additional values (see `unwrapCachedValue(Object)`.
private static final Function<AbstractClassGenerator<T>, Object>	GET_KEY
private final Set<String>	reservedClassNames
private final Predicate	uniqueNamePredicate

Constructor Summary

Access	Constructor and Description
public	ClassLoaderData(ClassLoader classLoader)

Method Summary

Modifier and Type	Method and Description
public Object	get(AbstractClassGenerator<T> gen, boolean useCache)
public ClassLoader	getClassLoader()
public Predicate	getUniqueNamePredicate()
public void	reserveName(String name)

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

Field Detail

classLoader	back to summary
private final WeakReference<ClassLoader> classLoader Note ClassLoaderData object is stored as a value of `WeakHashMap<ClassLoader, ...>` thus this classLoader reference should be weak otherwise it would make classLoader strongly reachable and alive forever. Reference queue is not required since the cleanup is handled by `WeakHashMap`.

generatedClasses back to summary

generatedClasses	back to summary
private final LoadingCache<AbstractClassGenerator<T>, Object, Object> generatedClasses `AbstractClassGenerator` here holds "cache key" (e.g. `org.springframework.cglib.proxy.Enhancer` configuration), and the value is the generated class plus some additional values (see `unwrapCachedValue(Object)`. The generated classes can be reused as long as their classloader is reachable. Note the only way to access a class is to find it through generatedClasses cache, thus the key should not expire as long as the class itself is alive (its classloader is alive).

private final LoadingCache<AbstractClassGenerator<T>, Object, Object> generatedClasses

AbstractClassGenerator here holds "cache key" (e.g. org.springframework.cglib.proxy.Enhancer configuration), and the value is the generated class plus some additional values (see unwrapCachedValue(Object).

The generated classes can be reused as long as their classloader is reachable.

Note

the only way to access a class is to find it through generatedClasses cache, thus the key should not expire as long as the class itself is alive (its classloader is alive).

GET_KEY	back to summary
private static final Function<AbstractClassGenerator<T>, Object> GET_KEY

reservedClassNames	back to summary
private final Set<String> reservedClassNames

uniqueNamePredicate	back to summary
private final Predicate uniqueNamePredicate

Constructor Detail

ClassLoaderData	back to summary
public ClassLoaderData(ClassLoader classLoader)

Method Detail

get	back to summary
public Object get(AbstractClassGenerator<T> gen, boolean useCache)

getClassLoader	back to summary
public ClassLoader getClassLoader()

getUniqueNamePredicate	back to summary
public Predicate getUniqueNamePredicate()

reserveName	back to summary
public void reserveName(String name)

public abstract Class AbstractClassGenerator<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class AbstractClassGenerator.ClassLoaderData

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class AbstractClassGenerator.Source

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail