AspectJ Weaver 1.9.20.1 · org.aspectj.weaver.bcel.BcelWeaver

Modifier and Type	Field and Description
private transient List<UnwovenClassFile>	addedClasses
private Set<IProgramElement>	candidatesForRemoval
public static final String	CLOSURE_CLASS_PREFIX
private CustomMungerFactory	customMungerFactory
private transient List<DeclareParents>	declareParentsList
private transient List<String>	deletedTypenames
private boolean	inReweavableMode
private boolean	isBatchWeave
private transient List<ConcreteTypeMunger>	lateTypeMungerList
private Manifest	manifest
private boolean	needToReweaveWorld
private transient List<ShadowMunger>	shadowMungerList
public static final String	SYNTHETIC_CLASS_POSTFIX
private static Trace	trace
private transient List<ConcreteTypeMunger>	typeMungerList
private final transient BcelWorld	world
private final CrosscuttingMembersSet	xcutSet
private ZipOutputStream	zipOutputStream

Access	Constructor and Description
public	BcelWeaver(BcelWorld world)

Method Summary

Modifier and Type	Method and Description
private List<ResolvedType>	Returns: the list of discovered aspects addAspectsFromDirectory(File the directory in which to look for Aspect .class files directory) Look for .class files that represent aspects in the supplied directory - return the list of accumulated aspects.
private List<ResolvedType>	addAspectsFromJarFile(File inFile)
public ReferenceType	addClassFile(UnwovenClassFile classFile, boolean fromInpath) Should be addOrReplace
public UnwovenClassFile	addClassFile(File classFile, File inPathDir, File outDir)
private void	addCustomMungers()
public List<UnwovenClassFile>	addDirectoryContents(File inFile, File outDir) Add any .class files in the directory to the outdir.
public List<UnwovenClassFile>	addJarFile(File inFile, File outDir, boolean canBeDirectory) Adds all class files in the jar
public ResolvedType	Returns: aspect addLibraryAspect(String aspectName) Add the given aspect to the weaver.
public void	addLibraryJarFile(File directory containing classes or zip/jar class archive inFile)
public void	addManifest(Manifest newManifest)
public void	addNormalTypeMungers(String typeName)
public void	addParentTypeMungers(String typeName)
public void	allWeavingComplete()
private boolean	applyDeclareAtType(DeclareAnnotation decA, ResolvedType onType, boolean reportProblems) Apply a declare @type - return true if we change the type
private boolean	applyDeclareParents(DeclareParents p, ResolvedType onType) Apply a single declare parents - return true if we change the type
private void	checkDeclareTypeErrorOrWarning(BcelWorld world2, BcelObjectType classType)
private boolean	couldEverMatchSameJoinPoints(Pointcut left, Pointcut right)
public void	deleteClassFile(String typename)
private void	dump(UnwovenClassFile classFile, LazyClassGen clazz)
private void	dumpUnchanged(UnwovenClassFile classFile)
private List<ShadowMunger>	Returns: a list of shadow mungers that might match with those that cannot (according to fast match rules) removed fastMatch(List<ShadowMunger> list of all shadow mungers that might match list, ResolvedType the target type type) Perform a fast match of the specified list of shadowmungers against the specified type.
private Pointcut	findFirstPointcutIn(Pointcut toSearch, Class<?> toLookFor)
public UnwovenClassFile[]	getClassFilesFor(LazyClassGen clazz)
public BcelObjectType	getClassType(String forClass) helper method - will return NULL if the underlying delegate is an EclipseSourceType and not a BcelObjectType
private String	getEntryName(String className)
public Manifest	getManifest(boolean shouldCreate)
public World	getWorld()
private boolean	hasInnerType(IProgramElement typeNode)
private ResolvedType	Returns: a ResolvedType if the classbytes represent an aspect, otherwise null isAspect(byte[] the classbytes that might represent an aspect classbytes, String the name of the class name, File directory which contained the class file dir) Determine if the supplied bytes represent an aspect, if they do then create a ResolvedType instance for the aspect and return it, otherwise return null
public boolean	isReweavable()
public boolean	needToReweaveWorld()
public void	prepareForWeave()
public void	prepareToProcessReweavableState()
public void	processReweavableStateIfPresent(String className, BcelObjectType classType)
private void	raiseAmbiguityInDisjunctionError(Pointcut userPointcut, List<String> names)
private void	raiseAmbiguousBindingError(String name, Pointcut pointcut)
private void	raiseNegationBindingError(Pointcut userPointcut)
private void	raiseUnboundFormalError(String name, Pointcut userPointcut)
private void	removeSourceFileIfNoMoreTypeDeclarationsInside(AspectJElementHierarchy hierarchy, IProgramElement typeElement, IProgramElement sourceFileNode)
private void	rewritePointcuts(List<ShadowMunger> shadowMungers)
public void	setCustomMungerFactory(CustomMungerFactory factory)
public void	setIsBatchWeave(boolean b)
public void	setReweavableMode(boolean xNotReweavable)
public void	setShadowMungers(List<ShadowMunger> shadowMungers)
private Pointcut	shareEntriesFromMap(Pointcut p, Map<Pointcut, Pointcut> pcMap)
public void	tidyUp()
private void	validateBindings(Pointcut dnfPointcut, Pointcut userPointcut, int numFormals, String[] names)
private void	validateOrBranch(OrPointcut pc, Pointcut userPointcut, int numFormals, String[] names, Pointcut[] leftBindings, Pointcut[] rightBindings)
private void	validateSingleBranch(Pointcut pc, Pointcut userPointcut, int numFormals, String[] names, Pointcut[] bindings)
private void	validateSingleBranchRecursion(Pointcut pc, Pointcut userPointcut, boolean[] foundFormals, String[] names, Pointcut[] bindings)
private boolean	verifyTargetIsOK(DeclareAnnotation decA, ResolvedType onType, AnnotationAJ annoX, boolean outputProblems) Checks for an @target() on the annotation and if found ensures it allows the annotation to be attached to the target type that matched.
private void	walkUpRemovingEmptyTypesAndPossiblyEmptySourceFile(AspectJElementHierarchy hierarchy, String tname, IProgramElement typeThatHasChildRemoved)
private void	warnOnUnmatchedAdvice() In 1.5 mode and with XLint:adviceDidNotMatch enabled, put out messages for any mungers that did not match anything.
public Collection<String>	weave(File file)
public Collection<String>	weave(IClassFileProvider input)
pack-priv LazyClassGen	weave(UnwovenClassFile classFile, BcelObjectType classType)
private LazyClassGen	weave(UnwovenClassFile classFile, BcelObjectType classType, boolean dump)
private void	weaveAndNotify(UnwovenClassFile classFile, BcelObjectType classType, IWeaveRequestor requestor)
public void	weaveNormalTypeMungers(ResolvedType onType)
private void	weaveParentsFor(List<String> typesForWeaving, String typeToWeave, ResolvedType resolvedTypeToWeave) 'typeToWeave' is one from the 'typesForWeaving' list.
public void	weaveParentTypeMungers(ResolvedType onType) Weaves new parents and annotations onto a type ("declare parents" and "declare @type") Algorithm: 1.
public LazyClassGen	weaveWithoutDump(UnwovenClassFile classFile, BcelObjectType classType)
public void	write(CompressingDataOutputStream dos)
private void	writeZipEntry(String name, byte[] bytes)

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

addedClasses	back to summary
private transient List<UnwovenClassFile> addedClasses

candidatesForRemoval	back to summary
private Set<IProgramElement> candidatesForRemoval

CLOSURE_CLASS_PREFIX	back to summary
public static final String CLOSURE_CLASS_PREFIX

customMungerFactory	back to summary
private CustomMungerFactory customMungerFactory

declareParentsList	back to summary
private transient List<DeclareParents> declareParentsList

deletedTypenames	back to summary
private transient List<String> deletedTypenames

inReweavableMode	back to summary
private boolean inReweavableMode

isBatchWeave	back to summary
private boolean isBatchWeave

lateTypeMungerList	back to summary
private transient List<ConcreteTypeMunger> lateTypeMungerList

manifest	back to summary
private Manifest manifest

needToReweaveWorld	back to summary
private boolean needToReweaveWorld

shadowMungerList	back to summary
private transient List<ShadowMunger> shadowMungerList

SYNTHETIC_CLASS_POSTFIX	back to summary
public static final String SYNTHETIC_CLASS_POSTFIX

trace	back to summary
private static Trace trace

typeMungerList	back to summary
private transient List<ConcreteTypeMunger> typeMungerList

world	back to summary
private final transient BcelWorld world

xcutSet	back to summary
private final CrosscuttingMembersSet xcutSet

zipOutputStream	back to summary
private ZipOutputStream zipOutputStream

BcelWeaver	back to summary
public BcelWeaver(BcelWorld world)

Method Detail

addAspectsFromDirectory	back to summary
private List<ResolvedType> addAspectsFromDirectory(File directory) throws FileNotFoundException, IOException Look for .class files that represent aspects in the supplied directory - return the list of accumulated aspects. Parameters directory:File the directory in which to look for Aspect .class files Returns:List<ResolvedType> the list of discovered aspects

addAspectsFromDirectory

back to summary

private List<ResolvedType> addAspectsFromDirectory(File directory) throws FileNotFoundException, IOException

Look for .class files that represent aspects in the supplied directory - return the list of accumulated aspects.

Parameters

directory:File: the directory in which to look for Aspect .class files

Returns:List<ResolvedType>

the list of discovered aspects

addAspectsFromJarFile	back to summary
private List<ResolvedType> addAspectsFromJarFile(File inFile) throws FileNotFoundException, IOException

addClassFile	back to summary
public ReferenceType addClassFile(UnwovenClassFile classFile, boolean fromInpath) Should be addOrReplace

addClassFile	back to summary
public UnwovenClassFile addClassFile(File classFile, File inPathDir, File outDir) throws IOException

addCustomMungers	back to summary
private void addCustomMungers()

addDirectoryContents	back to summary
public List<UnwovenClassFile> addDirectoryContents(File inFile, File outDir) throws IOException Add any .class files in the directory to the outdir. Anything other than .class files in the directory (or its subdirectories) are considered resources and are also copied.

addJarFile	back to summary
public List<UnwovenClassFile> addJarFile(File inFile, File outDir, boolean canBeDirectory) Adds all class files in the jar

addLibraryAspect	back to summary
public ResolvedType addLibraryAspect(String aspectName) Add the given aspect to the weaver. The type is resolved to support DOT for static inner classes as well as DOLLAR Returns:ResolvedType aspect

addLibraryAspect

back to summary

public ResolvedType addLibraryAspect(String aspectName)

Add the given aspect to the weaver. The type is resolved to support DOT for static inner classes as well as DOLLAR

Returns:ResolvedType: aspect

addLibraryJarFile	back to summary
public void addLibraryJarFile(File inFile) throws IOException Parameters inFile:File directory containing classes or zip/jar class archive

addManifest	back to summary
public void addManifest(Manifest newManifest)

addNormalTypeMungers	back to summary
public void addNormalTypeMungers(String typeName)

addParentTypeMungers	back to summary
public void addParentTypeMungers(String typeName)

allWeavingComplete	back to summary
public void allWeavingComplete()

applyDeclareAtType	back to summary
private boolean applyDeclareAtType(DeclareAnnotation decA, ResolvedType onType, boolean reportProblems) Apply a declare @type - return true if we change the type

applyDeclareParents	back to summary
private boolean applyDeclareParents(DeclareParents p, ResolvedType onType) Apply a single declare parents - return true if we change the type

checkDeclareTypeErrorOrWarning	back to summary
private void checkDeclareTypeErrorOrWarning(BcelWorld world2, BcelObjectType classType)

couldEverMatchSameJoinPoints	back to summary
private boolean couldEverMatchSameJoinPoints(Pointcut left, Pointcut right)

deleteClassFile	back to summary
public void deleteClassFile(String typename)

dump	back to summary
private void dump(UnwovenClassFile classFile, LazyClassGen clazz) throws IOException

dumpUnchanged	back to summary
private void dumpUnchanged(UnwovenClassFile classFile) throws IOException

fastMatch	back to summary
private List<ShadowMunger> fastMatch(List<ShadowMunger> list, ResolvedType type) Perform a fast match of the specified list of shadowmungers against the specified type. A subset of those that might match is returned. Parameters list:List<ShadowMunger> list of all shadow mungers that might match type:ResolvedType the target type Returns:List<ShadowMunger> a list of shadow mungers that might match with those that cannot (according to fast match rules) removed

fastMatch

back to summary

private List<ShadowMunger> fastMatch(List<ShadowMunger> list, ResolvedType type)

Perform a fast match of the specified list of shadowmungers against the specified type. A subset of those that might match is returned.

Parameters

list:List<ShadowMunger>: list of all shadow mungers that might match
type:ResolvedType: the target type

Returns:List<ShadowMunger>

a list of shadow mungers that might match with those that cannot (according to fast match rules) removed

findFirstPointcutIn	back to summary
private Pointcut findFirstPointcutIn(Pointcut toSearch, Class<?> toLookFor)

getClassFilesFor	back to summary
public UnwovenClassFile[] getClassFilesFor(LazyClassGen clazz)

getClassType	back to summary
public BcelObjectType getClassType(String forClass) helper method - will return NULL if the underlying delegate is an EclipseSourceType and not a BcelObjectType

getEntryName	back to summary
private String getEntryName(String className)

getManifest	back to summary
public Manifest getManifest(boolean shouldCreate)

getWorld	back to summary
public World getWorld()

hasInnerType	back to summary
private boolean hasInnerType(IProgramElement typeNode)

isAspect

back to summary

private ResolvedType isAspect(byte[] classbytes, String name, File dir) throws IOException

Determine if the supplied bytes represent an aspect, if they do then create a ResolvedType instance for the aspect and return it, otherwise return null

Parameters

classbytes:byte[]: the classbytes that might represent an aspect
name:String: the name of the class
dir:File: directory which contained the class file

Returns:ResolvedType

a ResolvedType if the classbytes represent an aspect, otherwise null

isReweavable	back to summary
public boolean isReweavable()

needToReweaveWorld	back to summary
public boolean needToReweaveWorld()

prepareForWeave	back to summary
public void prepareForWeave()

prepareToProcessReweavableState	back to summary
public void prepareToProcessReweavableState()

processReweavableStateIfPresent	back to summary
public void processReweavableStateIfPresent(String className, BcelObjectType classType)

raiseAmbiguityInDisjunctionError	back to summary
private void raiseAmbiguityInDisjunctionError(Pointcut userPointcut, List<String> names)

raiseAmbiguousBindingError	back to summary
private void raiseAmbiguousBindingError(String name, Pointcut pointcut)

raiseNegationBindingError	back to summary
private void raiseNegationBindingError(Pointcut userPointcut)

raiseUnboundFormalError	back to summary
private void raiseUnboundFormalError(String name, Pointcut userPointcut)

removeSourceFileIfNoMoreTypeDeclarationsInside	back to summary
private void removeSourceFileIfNoMoreTypeDeclarationsInside(AspectJElementHierarchy hierarchy, IProgramElement typeElement, IProgramElement sourceFileNode)

rewritePointcuts	back to summary
private void rewritePointcuts(List<ShadowMunger> shadowMungers)

setCustomMungerFactory	back to summary
public void setCustomMungerFactory(CustomMungerFactory factory)

setIsBatchWeave	back to summary
public void setIsBatchWeave(boolean b)

setReweavableMode	back to summary
public void setReweavableMode(boolean xNotReweavable)

setShadowMungers	back to summary
public void setShadowMungers(List<ShadowMunger> shadowMungers)

shareEntriesFromMap	back to summary
private Pointcut shareEntriesFromMap(Pointcut p, Map<Pointcut, Pointcut> pcMap)

tidyUp	back to summary
public void tidyUp()

validateBindings	back to summary
private void validateBindings(Pointcut dnfPointcut, Pointcut userPointcut, int numFormals, String[] names)

validateOrBranch	back to summary
private void validateOrBranch(OrPointcut pc, Pointcut userPointcut, int numFormals, String[] names, Pointcut[] leftBindings, Pointcut[] rightBindings)

validateSingleBranch	back to summary
private void validateSingleBranch(Pointcut pc, Pointcut userPointcut, int numFormals, String[] names, Pointcut[] bindings)

validateSingleBranchRecursion	back to summary
private void validateSingleBranchRecursion(Pointcut pc, Pointcut userPointcut, boolean[] foundFormals, String[] names, Pointcut[] bindings)

verifyTargetIsOK	back to summary
private boolean verifyTargetIsOK(DeclareAnnotation decA, ResolvedType onType, AnnotationAJ annoX, boolean outputProblems) Checks for an @target() on the annotation and if found ensures it allows the annotation to be attached to the target type that matched.

walkUpRemovingEmptyTypesAndPossiblyEmptySourceFile	back to summary
private void walkUpRemovingEmptyTypesAndPossiblyEmptySourceFile(AspectJElementHierarchy hierarchy, String tname, IProgramElement typeThatHasChildRemoved)

warnOnUnmatchedAdvice	back to summary
private void warnOnUnmatchedAdvice() In 1.5 mode and with XLint:adviceDidNotMatch enabled, put out messages for any mungers that did not match anything.

weave	back to summary
public Collection<String> weave(File file) throws IOException

weave	back to summary
public Collection<String> weave(IClassFileProvider input) throws IOException

weave	back to summary
pack-priv LazyClassGen weave(UnwovenClassFile classFile, BcelObjectType classType) throws IOException

weave	back to summary
private LazyClassGen weave(UnwovenClassFile classFile, BcelObjectType classType, boolean dump) throws IOException

weaveAndNotify	back to summary
private void weaveAndNotify(UnwovenClassFile classFile, BcelObjectType classType, IWeaveRequestor requestor) throws IOException

weaveNormalTypeMungers	back to summary
public void weaveNormalTypeMungers(ResolvedType onType)

weaveParentsFor

back to summary

private void weaveParentsFor(List<String> typesForWeaving, String typeToWeave, ResolvedType resolvedTypeToWeave)

'typeToWeave' is one from the 'typesForWeaving' list. This routine ensures we process supertypes (classes/interfaces) of 'typeToWeave' that are in the 'typesForWeaving' list before 'typeToWeave' itself. 'typesToWeave' is then removed from the 'typesForWeaving' list.

Note

Future gotcha in here ... when supplying partial hierarchies, this algorithm may break down. If you have a hierarchy A>B>C and only give A and C to the weaver, it may choose to weave them in either order - but you'll probably have other problems if you are supplying partial hierarchies like that !

weaveParentTypeMungers

back to summary

public void weaveParentTypeMungers(ResolvedType onType)

Weaves new parents and annotations onto a type ("declare parents" and "declare @type") Algorithm: 1. First pass, do parents then do annotations. During this pass record: - any parent mungers that don't match but have a non-wild annotation type pattern - any annotation mungers that don't match 2. Multiple subsequent passes which go over the munger lists constructed in the first pass, repeatedly applying them until nothing changes. FIXME asc confirm that algorithm is optimal ??

weaveWithoutDump	back to summary
public LazyClassGen weaveWithoutDump(UnwovenClassFile classFile, BcelObjectType classType) throws IOException

write	back to summary
public void write(CompressingDataOutputStream dos) throws IOException

writeZipEntry	back to summary
private void writeZipEntry(String name, byte[] bytes) throws IOException

public Class BcelWeaver

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail