Package io.ebean.enhance.common

Class EnhanceContext

java.lang.Object

io.ebean.enhance.common.EnhanceContext

public final class EnhanceContext
extends Object

Used to hold metadata, arguments and log levels for the enhancement.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EnhanceContext.ProfileLineNumberMode

Constructor Summary

Constructors

Constructor	Description
EnhanceContext(ClassBytesReader classBytesReader, String agentArgs, AgentManifest manifest)
EnhanceContext(ClassBytesReader classBytesReader, String agentArgs, AgentManifest manifest, ClassMetaCache metaCache)	Construct a context for enhancement.

Method Summary

Modifier and Type	Method	Description
int	accPrivate()
int	accProtected()
int	accPublic()
void	addClassMeta(ClassMeta meta)
byte[]	classBytes(String className, ClassLoader classLoader)
void	collectSummary()	Turn on the summary collection of the enhancement.
ClassMeta	createClassMeta()	Create a new meta object for enhancing a class.
boolean	detectEntityTransactionalEnhancement(String className)	Return true if this class should be scanned for transactional enhancement.
boolean	detectQueryBeanEnhancement(String className)	Return true if this class should be scanned for query bean enhancement.
Set<String>	entityPackages()
boolean	fluidQueryBuilders()
ClassMeta	get(String className)
String	getPackagesSummary()	Deprecated.
SummaryInfo	getSummaryInfo()	Deprecated.
boolean	improvedQueryBeans()
boolean	interceptAddReadOnly()
String	interceptNew()
ClassMeta	interfaceMeta(String interfaceClassName, ClassLoader classLoader)	Read the class metadata for an interface.
boolean	isAllowNullableDbArray()
boolean	isCheckNullManyFields()	Return true if we should add null checking on *ToMany fields.
boolean	isEnableEntityFieldAccess()
boolean	isEnableProfileLocation()	Return true if profile location enhancement is on.
boolean	isEnhancedToString()
boolean	isEntityBean(String owner)
boolean	isIgnoreClass(String className)	Return true if this class should be ignored.
boolean	isLog(int level)
boolean	isQueryBean(String owner, ClassLoader classLoader)	Return true if the owner class is a type query bean.
boolean	isThrowOnError()	Return true if transform should throw exception rather than log and return null.
boolean	isToManyGetField()
boolean	isTransientInit()
boolean	isTransientInitThrowError()
boolean	isTransientInternalFields()	Return true if internal ebean fields in entity classes should be transient.
void	log(int level, String className, String msg)	Log some debug output.
void	log(String className, String msg)
void	log(Throwable e)	Log an error.
int	logLevel()	Return the log level.
String	packagesSummary()	Return the summary of the packages controlling enhancement.
EnhanceContext.ProfileLineNumberMode	profileLineMode()
Set<String>	querybeanPackages()
void	setLogLevel(int logLevel)
void	setLogout(MessageOutput logout)	Change the logout to something other than system out.
void	setThrowOnError(boolean throwOnError)	Set to true if you want transform to throw exceptions rather than return null.
void	summaryEntity(String className)	Add the entity enhanced class to summary information.
void	summaryFieldAccessUser(String className)	Add the enhanced class with field access replacement to summary information.
SummaryInfo	summaryInfo()	Return the summary of the enhancement.
void	summaryQueryBean(String className)	Add the query bean enhanced class to summary information.
void	summaryQueryBeanCaller(String className)	Add the query bean caller enhanced class to summary information.
void	summaryTransactional(String className)	Add the transactional enhanced class to summary information.
ClassMeta	superMeta(String superClassName, ClassLoader classLoader)	Read the class metadata for a super class.
boolean	supportsProfileWithLine()
Set<String>	transactionalPackages()
void	visitMethodInsnIntercept(MethodVisitor mv, String name, String desc)
void	withClassLoader(ClassLoader loader)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EnhanceContext

public EnhanceContext(ClassBytesReader classBytesReader,
 String agentArgs,
 AgentManifest manifest)

EnhanceContext

public EnhanceContext(ClassBytesReader classBytesReader,
 String agentArgs,
 AgentManifest manifest,
 ClassMetaCache metaCache)

Construct a context for enhancement.

Method Details

withClassLoader

public void withClassLoader(ClassLoader loader)

setLogLevel

public void setLogLevel(int logLevel)

getPackagesSummary

@Deprecated
public String getPackagesSummary()

Deprecated.

packagesSummary

public String packagesSummary()

Return the summary of the packages controlling enhancement.

entityPackages

public Set<String> entityPackages()

transactionalPackages

public Set<String> transactionalPackages()

querybeanPackages

public Set<String> querybeanPackages()

classBytes

public byte[] classBytes(String className,
 ClassLoader classLoader)

isEntityBean

public boolean isEntityBean(String owner)

isQueryBean

public boolean isQueryBean(String owner,
 ClassLoader classLoader)

Return true if the owner class is a type query bean.

If true typically means the caller needs to change GETFIELD calls to instead invoke the generated 'property access' methods.

isEnableEntityFieldAccess

public boolean isEnableEntityFieldAccess()

isEnableProfileLocation

public boolean isEnableProfileLocation()

Return true if profile location enhancement is on.

detectEntityTransactionalEnhancement

public boolean detectEntityTransactionalEnhancement(String className)

Return true if this class should be scanned for transactional enhancement.

detectQueryBeanEnhancement

public boolean detectQueryBeanEnhancement(String className)

Return true if this class should be scanned for query bean enhancement.

isIgnoreClass

public boolean isIgnoreClass(String className)

Return true if this class should be ignored. That is JDK classes and known libraries JDBC drivers etc can be skipped.

setLogout

public void setLogout(MessageOutput logout)

Change the logout to something other than system out.

createClassMeta

public ClassMeta createClassMeta()

Create a new meta object for enhancing a class.

superMeta

public ClassMeta superMeta(String superClassName,
 ClassLoader classLoader)

Read the class metadata for a super class.

Typically used to read meta data for inheritance hierarchy.

interfaceMeta

public ClassMeta interfaceMeta(String interfaceClassName,
 ClassLoader classLoader)

Read the class metadata for an interface.

Typically used to check the interface to see if it is transactional.

addClassMeta

public void addClassMeta(ClassMeta meta)

get

public ClassMeta get(String className)

log

public void log(int level,
 String className,
 String msg)

Log some debug output.

log

public void log(String className,
 String msg)

isLog

public boolean isLog(int level)

log

public void log(Throwable e)

Log an error.

logLevel

public int logLevel()

Return the log level.

isTransientInit

public boolean isTransientInit()

isTransientInitThrowError

public boolean isTransientInitThrowError()

isTransientInternalFields

public boolean isTransientInternalFields()

Return true if internal ebean fields in entity classes should be transient.

isCheckNullManyFields

public boolean isCheckNullManyFields()

Return true if we should add null checking on *ToMany fields.

On getting a many that is null Ebean will create an empty List, Set or Map. If it is a ManyToMany it will turn on Modify listening.

isAllowNullableDbArray

public boolean isAllowNullableDbArray()

isThrowOnError

public boolean isThrowOnError()

Return true if transform should throw exception rather than log and return null.

setThrowOnError

public void setThrowOnError(boolean throwOnError)

Set to true if you want transform to throw exceptions rather than return null.

collectSummary

public void collectSummary()

Turn on the summary collection of the enhancement.

summaryTransactional

public void summaryTransactional(String className)

Add the transactional enhanced class to summary information.

summaryEntity

public void summaryEntity(String className)

Add the entity enhanced class to summary information.

summaryQueryBean

public void summaryQueryBean(String className)

Add the query bean enhanced class to summary information.

summaryQueryBeanCaller

public void summaryQueryBeanCaller(String className)

Add the query bean caller enhanced class to summary information.

summaryFieldAccessUser

public void summaryFieldAccessUser(String className)

Add the enhanced class with field access replacement to summary information.

getSummaryInfo

@Deprecated
public SummaryInfo getSummaryInfo()

Deprecated.

summaryInfo

public SummaryInfo summaryInfo()

Return the summary of the enhancement.

Note that collectSummary() must be called in order for summary information to be collected and returned here.

accPublic

public int accPublic()

accProtected

public int accProtected()

accPrivate

public int accPrivate()

isToManyGetField

public boolean isToManyGetField()

isEnhancedToString

public boolean isEnhancedToString()

interceptNew

public String interceptNew()

visitMethodInsnIntercept

public void visitMethodInsnIntercept(MethodVisitor mv,
 String name,
 String desc)

interceptAddReadOnly

public boolean interceptAddReadOnly()

supportsProfileWithLine

public boolean supportsProfileWithLine()

improvedQueryBeans

public boolean improvedQueryBeans()

fluidQueryBuilders

public boolean fluidQueryBuilders()

profileLineMode

public EnhanceContext.ProfileLineNumberMode profileLineMode()