com.avaje.ebean.enhance.agent

Class EnhanceContext

java.lang.Object

com.avaje.ebean.enhance.agent.EnhanceContext

public class EnhanceContext
extends Object

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

Constructor Summary

Constructors

Constructor and Description
EnhanceContext(ClassBytesReader classBytesReader, String agentArgs, Set<String> packages) Construct a context for enhancement.

Method Summary

Modifier and Type	Method and Description
void	addClassMeta(ClassMeta meta)
ClassMeta	createClassMeta() Create a new meta object for enhancing a class.
ClassMeta	get(String className)
byte[]	getClassBytes(String className, ClassLoader classLoader)
ClassMeta	getInterfaceMeta(String interfaceClassName, ClassLoader classLoader) Read the class meta data for an interface.
int	getLogLevel() Return the log level.
String	getProperty(String key) Return a value from the agent arguments using its key.
boolean	getPropertyBoolean(String key, boolean dflt)
ClassMeta	getSuperMeta(String superClassName, ClassLoader classLoader) Read the class meta data for a super class.
boolean	isCheckNullManyFields() Return true if we should add null checking on *ToMany fields.
boolean	isIgnoreClass(String className) Return true if this class should be ignored.
boolean	isLog(int level)
boolean	isReadOnly() Return true if this should go through the enhancement process but not actually save the enhanced classes.
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.
void	setLogout(MessageOutput logout) Change the logout to something other than system out.

Methods inherited from class java.lang.Object

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

Constructor Detail

EnhanceContext

public EnhanceContext(ClassBytesReader classBytesReader,
                      String agentArgs,
                      Set<String> packages)

Construct a context for enhancement.

Parameters:

classBytesReader - used to read class meta data from raw bytes

agentArgs - command line arguments for debug level etc

packages - limit enhancement to specified packages

Method Detail

getClassBytes

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

getProperty

public String getProperty(String key)

Return a value from the agent arguments using its key.

getPropertyBoolean

public boolean getPropertyBoolean(String key,
                                  boolean dflt)

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.

getSuperMeta

public ClassMeta getSuperMeta(String superClassName,
                              ClassLoader classLoader)

Read the class meta data for a super class.

Typically used to read meta data for inheritance hierarchy.

getInterfaceMeta

public ClassMeta getInterfaceMeta(String interfaceClassName,
                                  ClassLoader classLoader)

Read the class meta data 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.

getLogLevel

public int getLogLevel()

Return the log level.

isReadOnly

public boolean isReadOnly()

Return true if this should go through the enhancement process but not actually save the enhanced classes.

Set this to true to run through the enhancement process without actually doing the enhancement for debugging etc.

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.