Modifier and Type	Class and Description
private static class	ConverterPropertyEditorFactory.ClassTemplateInfo Capture information extracted from a "template" PropertyEditor class, and perform manipulation of the byte codes in order to generate the bytes for a new PropertyEditor class.
private class	ConverterPropertyEditorFactory.DisposableClassLoader A custom class loader for the definition of the generated classes.

Modifier and Type	Field and Description
private Map<ClassLoader, WeakReference<ConverterPropertyEditorFactory.DisposableClassLoader>>	classLoaderCache
private static ConverterPropertyEditorFactory	defaultInstance
private static final Logger	LOGGER
private static final Pattern	MultipleUnderscorePattern
private static final Map<Character, String>	PRIM_MAP
private static final Pattern	SingleUnderscorePattern
private final ConverterPropertyEditorFactory.ClassTemplateInfo	templateInfo
private static final Pattern	UNDERSCORE_PATTERN

Access	Constructor and Description
public	ConverterPropertyEditorFactory() Create a `ConverterPropertyEditorFactory` that uses the default template class (`ConverterPropertyEditorFor_XXXX`).
public	ConverterPropertyEditorFactory(Class<? extends ConverterPropertyEditorBase> the template templateClass) Create a `ConverterPropertyEditorFactory` that uses the specified template class.

Modifier and Type	Method and Description
public Class<? extends ConverterPropertyEditorBase>	Returns: the dynamically generated PropertyEditor class. definePropertyEditorClassFor(final Class<?> the class of object that the returned property editor class will be editing. targetClass) Return a PropertyEditor class appropriate for editing the given `targetClass`.
public static synchronized ConverterPropertyEditorFactory	Returns: the single default instance of this class (created with the default template class). getDefaultInstance()
private ConverterPropertyEditorFactory.ClassTemplateInfo	getTemplateInfo()
private static byte[]	Returns: the bytes for the UTF8Info constant pool entry, including the tag, length, and utf8 content. getUtf8InfoBytes(String the text to create the UTF8 constant from. text) Create a UTF8Info constant pool structure for the given text.
private static String	Returns: the binary name of the class as used by the VM ('/' instead of '.' as a package name separator). getVMClassName(Class<?> the class to find the name of. c)

classLoaderCache	back to summary
private Map<ClassLoader, WeakReference<ConverterPropertyEditorFactory.DisposableClassLoader>> classLoaderCache

defaultInstance	back to summary
private static ConverterPropertyEditorFactory defaultInstance

LOGGER	back to summary
private static final Logger LOGGER

MultipleUnderscorePattern	back to summary
private static final Pattern MultipleUnderscorePattern

PRIM_MAP	back to summary
private static final Map<Character, String> PRIM_MAP

SingleUnderscorePattern	back to summary
private static final Pattern SingleUnderscorePattern

templateInfo	back to summary
private final ConverterPropertyEditorFactory.ClassTemplateInfo templateInfo

UNDERSCORE_PATTERN	back to summary
private static final Pattern UNDERSCORE_PATTERN

ConverterPropertyEditorFactory	back to summary
public ConverterPropertyEditorFactory() Create a `ConverterPropertyEditorFactory` that uses the default template class (`ConverterPropertyEditorFor_XXXX`).

ConverterPropertyEditorFactory	back to summary
public ConverterPropertyEditorFactory(Class<? extends ConverterPropertyEditorBase> templateClass) Create a `ConverterPropertyEditorFactory` that uses the specified template class. Parameters templateClass:Class<? extends ConverterPropertyEditorBase> the template

definePropertyEditorClassFor	back to summary
public Class<? extends ConverterPropertyEditorBase> definePropertyEditorClassFor(final Class<?> targetClass) Return a PropertyEditor class appropriate for editing the given `targetClass`. The new class will be defined from a DisposableClassLoader. Parameters targetClass:Class<?> the class of object that the returned property editor class will be editing. Returns:Class<? extends ConverterPropertyEditorBase> the dynamically generated PropertyEditor class. Annotations @SuppressWarnings:unchecked

getDefaultInstance	back to summary
public static synchronized ConverterPropertyEditorFactory getDefaultInstance() Returns:ConverterPropertyEditorFactory the single default instance of this class (created with the default template class).

getTemplateInfo	back to summary
private ConverterPropertyEditorFactory.ClassTemplateInfo getTemplateInfo()

getUtf8InfoBytes	back to summary
private static byte[] getUtf8InfoBytes(String text) Create a UTF8Info constant pool structure for the given text. Parameters text:String the text to create the UTF8 constant from. Returns:byte[] the bytes for the UTF8Info constant pool entry, including the tag, length, and utf8 content.

getVMClassName	back to summary
private static String getVMClassName(Class<?> c) Parameters c:Class<?> the class to find the name of. Returns:String the binary name of the class as used by the VM ('/' instead of '.' as a package name separator).

com.sun.faces.application back to summary

private Class ConverterPropertyEditorFactory.ClassTemplateInfo

Class Inheritance

extends Object

java.lang.Object
com.sun.faces.application.ConverterPropertyEditorFactory.ClassTemplateInfo

Capture information extracted from a "template" PropertyEditor class, and perform manipulation of the byte codes in order to generate the bytes for a new PropertyEditor class.

The new class bytes are generated by identifying UTF8Info entries in the constant pool of the template class, and replacing them with new UTF8 constants to define a new class. The constants to be replaced are those for:

The name of the class itself (com/sun/faces/application/ConverterPropertyEditorFor_XXXX).
The class name as a type reference (Lcom/sun/faces/application/ConverterPropertyEditorFor_XXXX;).
The name of the target class that the editor will be manipulating (java/util/Date in the current template).

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef Capture details of the location of a UTF8Info entry in the constant pool of the template class.
private static class	ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement Capture details of a single substitution to be made in the template class while generating the new class.

Field Summary

Modifier and Type	Field and Description
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef	classNameConstant
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef	classNameRefConstant
private int	constant_pool_count
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef	targetClassConstant
private byte[]	templateBytes
private final Class<? extends ConverterPropertyEditorBase>	templateClass

Constructor Summary

Access	Constructor and Description
public	ClassTemplateInfo() Default constructor uses the `ConverterPropertyEditorFor_XXXX` class as the source template.
public	ClassTemplateInfo(Class<? extends ConverterPropertyEditorBase> is a "template" class (but not in the java generics sense) which must extend `ConverterPropertyEditorBase` and override the `ConverterPropertyEditorBase#getTargetClass` method. templateClass) Construct a template info instance based on the supplied class.

Method Summary

Modifier and Type	Method and Description
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef	Returns: A `Utf8InfoRef` instance refering to the matched constant pool entry, or `null` if no match was found. findConstant(String the text that the UTF8Info must contain. text) Find an instance of UTF8Info in the source class's constant pool where the text matches the given argument.
public byte[]	Returns: the bytes for a new class with the given name and target class. generateClassBytesFor(String the binary name of the new class. newClassName, String the binary name of the PropertyEditor's target class. targetClassName)
public String	Returns: The full name to use for the generated PropertyEditor class. generateClassNameFor(Class<?> The target class which the PropertyEditor will operate on. targetClass, boolean If true, the package name components will be '/' separated. Otherwise they will be '.' separated. vmFormat) Generate a class name to use for the generated PropertyEditor class, based on the full name of the target class.
public String	Returns: the target class name, or null if the given `className` was not a generated PropertyEditor name. getTargetClassName(String name of the generated PropertyEditor class. className) Extract the original target class name from the generated PropertyEditor class name.
private void	loadTemplateBytes() Obtain the bytes that define the given class by looking for the ".class" resource and loading the binary data.
private boolean	Returns: true if the bytes from `targetBytes` match the bytes from `templateBytes`. matchAtIndex(byte[] byte array to compare. targetBytes, int the index into `templateBytes` at which to compare. index) Check whether the `targetBytes` match the content of the `templateBytes` at the given `index`.
private byte[]	Returns: the bytes for the new class definition. replaceInTemplate(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement... one or more Utf8InfoReplacments replacements) Generate the bytes for a new class based on the `templateBytes`, but with all the replacements in `replacements` performed.

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

Field Detail

classNameConstant	back to summary
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef classNameConstant

classNameRefConstant	back to summary
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef classNameRefConstant

constant_pool_count	back to summary
private int constant_pool_count

targetClassConstant	back to summary
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef targetClassConstant

templateBytes	back to summary
private byte[] templateBytes

templateClass	back to summary
private final Class<? extends ConverterPropertyEditorBase> templateClass

Constructor Detail

ClassTemplateInfo	back to summary
public ClassTemplateInfo() Default constructor uses the `ConverterPropertyEditorFor_XXXX` class as the source template.

ClassTemplateInfo back to summary

ClassTemplateInfo	back to summary
public ClassTemplateInfo(Class<? extends ConverterPropertyEditorBase> templateClass) Construct a template info instance based on the supplied class. Parameters templateClass:Class<? extends ConverterPropertyEditorBase> is a "template" class (but not in the java generics sense) which must extend `ConverterPropertyEditorBase` and override the `ConverterPropertyEditorBase#getTargetClass` method.

public ClassTemplateInfo(Class<? extends ConverterPropertyEditorBase> templateClass)

Construct a template info instance based on the supplied class.

Parameters

templateClass:Class<? extends ConverterPropertyEditorBase>: is a "template" class (but not in the java generics sense) which must extend ConverterPropertyEditorBase and override the ConverterPropertyEditorBase#getTargetClass method.

Method Detail

findConstant back to summary

findConstant	back to summary
private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef findConstant(String text) Find an instance of UTF8Info in the source class's constant pool where the text matches the given argument. Parameters text:String the text that the UTF8Info must contain. Returns:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef A `Utf8InfoRef` instance refering to the matched constant pool entry, or `null` if no match was found.

private ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef findConstant(String text)

Find an instance of UTF8Info in the source class's constant pool where the text matches the given argument.

Parameters

text:String: the text that the UTF8Info must contain.

Returns:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef

A Utf8InfoRef instance refering to the matched constant pool entry, or null if no match was found.

generateClassBytesFor	back to summary
public byte[] generateClassBytesFor(String newClassName, String targetClassName) Parameters newClassName:String the binary name of the new class. targetClassName:String the binary name of the PropertyEditor's target class. Returns:byte[] the bytes for a new class with the given name and target class.

generateClassNameFor	back to summary
public String generateClassNameFor(Class<?> targetClass, boolean vmFormat) Generate a class name to use for the generated PropertyEditor class, based on the full name of the target class. This is done by replacing the "XXXX" in the template class name with a version of the target class name. Parameters targetClass:Class<?> The target class which the PropertyEditor will operate on. vmFormat:boolean If true, the package name components will be '/' separated. Otherwise they will be '.' separated. Returns:String The full name to use for the generated PropertyEditor class.

generateClassNameFor

back to summary

public String generateClassNameFor(Class<?> targetClass, boolean vmFormat)

Generate a class name to use for the generated PropertyEditor class, based on the full name of the target class. This is done by replacing the "XXXX" in the template class name with a version of the target class name.

Parameters

targetClass:Class<?>: The target class which the PropertyEditor will operate on.
vmFormat:boolean: If true, the package name components will be '/' separated. Otherwise they will be '.' separated.

Returns:String

The full name to use for the generated PropertyEditor class.

getTargetClassName back to summary

getTargetClassName	back to summary
public String getTargetClassName(String className) Extract the original target class name from the generated PropertyEditor class name. (This is the reverse of `generateClassNameFor`). Parameters className:String name of the generated PropertyEditor class. Returns:String the target class name, or null if the given `className` was not a generated PropertyEditor name.

public String getTargetClassName(String className)

Extract the original target class name from the generated PropertyEditor class name. (This is the reverse of generateClassNameFor).

Parameters

className:String: name of the generated PropertyEditor class.

Returns:String

the target class name, or null if the given className was not a generated PropertyEditor name.

loadTemplateBytes	back to summary
private void loadTemplateBytes() throws IOException Obtain the bytes that define the given class by looking for the ".class" resource and loading the binary data. Exceptions IOException: if an error occurs loading the binary data

loadTemplateBytes

back to summary

private void loadTemplateBytes() throws IOException

Obtain the bytes that define the given class by looking for the ".class" resource and loading the binary data.

Exceptions

IOException:: if an error occurs loading the binary data

matchAtIndex back to summary

matchAtIndex	back to summary
private boolean matchAtIndex(byte[] targetBytes, int index) Check whether the `targetBytes` match the content of the `templateBytes` at the given `index`. Parameters targetBytes:byte[] byte array to compare. index:int the index into `templateBytes` at which to compare. Returns:boolean true if the bytes from `targetBytes` match the bytes from `templateBytes`.

private boolean matchAtIndex(byte[] targetBytes, int index)

Check whether the targetBytes match the content of the templateBytes at the given index.

Parameters

targetBytes:byte[]: byte array to compare.
index:int: the index into templateBytes at which to compare.

Returns:boolean

true if the bytes from targetBytes match the bytes from templateBytes.

replaceInTemplate back to summary

replaceInTemplate	back to summary
private byte[] replaceInTemplate(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement... replacements) Generate the bytes for a new class based on the `templateBytes`, but with all the replacements in `replacements` performed. Parameters replacements:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement[] one or more Utf8InfoReplacments Returns:byte[] the bytes for the new class definition.

private byte[] replaceInTemplate(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement... replacements)

Generate the bytes for a new class based on the templateBytes, but with all the replacements in replacements performed.

Parameters

replacements:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement[]: one or more Utf8InfoReplacments

Returns:byte[]

the bytes for the new class definition.

com.sun.faces.application back to summary

private Class ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef

Class Inheritance

extends Object

java.lang.Object
com.sun.faces.application.ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef

Capture details of the location of a UTF8Info entry in the constant pool of the template class.

Field Summary

Modifier and Type	Field and Description
pack-priv int	index The position of the constant in the byte array that defines the template class.
pack-priv int	length The number of bytes that the constant occupies in the byte array that defines the template class.

Constructor Summary

Access	Constructor and Description
public	Utf8InfoRef(int index, int length)

Method Summary

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

Field Detail

index	back to summary
pack-priv int index The position of the constant in the byte array that defines the template class.

length	back to summary
pack-priv int length The number of bytes that the constant occupies in the byte array that defines the template class.

Constructor Detail

Utf8InfoRef	back to summary
public Utf8InfoRef(int index, int length)

com.sun.faces.application back to summary

private Class ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement

Class Inheritance

extends Object
implements Comparable<ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement>

java.lang.Object
com.sun.faces.application.ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement

All Implemented Interfaces

java.lang.Comparable

Capture details of a single substitution to be made in the template class while generating the new class. Implements java.lang.Comparable so that the replacements can be ordered according to the order they appear in the source.

Field Summary

Modifier and Type	Field and Description
pack-priv ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef	ref The utf8 constant reference from the template source.
pack-priv byte[]	replacement The bytes to replace the constant with (must also be a valid utf8 constant pool entry).

Constructor Summary

Access	Constructor and Description
public	Utf8InfoReplacement(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef ref, String replacement)

Method Summary

Modifier and Type	Method and Description
public int	compareTo(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement the object to be compared. rhs) Implements java.lang.Comparable.compareTo. Order by the index position of the source UTF8Info reference.

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

Field Detail

ref	back to summary
pack-priv ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef ref The utf8 constant reference from the template source.

replacement	back to summary
pack-priv byte[] replacement The bytes to replace the constant with (must also be a valid utf8 constant pool entry).

Constructor Detail

Utf8InfoReplacement	back to summary
public Utf8InfoReplacement(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoRef ref, String replacement)

Method Detail

compareTo	back to summary
public int compareTo(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement rhs) Implements java.lang.Comparable.compareTo. Order by the index position of the source UTF8Info reference. Parameters rhs:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement Doc from java.lang.Comparable.compareTo. the object to be compared. Returns:int Doc from java.lang.Comparable.compareTo. a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. Annotations @Override

compareTo

back to summary

public int compareTo(ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement rhs)

Implements java.lang.Comparable.compareTo.

Order by the index position of the source UTF8Info reference.

Parameters

rhs:ConverterPropertyEditorFactory.ClassTemplateInfo.Utf8InfoReplacement

Doc from java.lang.Comparable.compareTo.

the object to be compared.

Returns:int

Doc from java.lang.Comparable.compareTo.

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Annotations

@Override

com.sun.faces.application back to summary

private Class ConverterPropertyEditorFactory.DisposableClassLoader

Class Inheritance

extends ClassLoader

java.lang.Object
java.lang.ClassLoader
com.sun.faces.application.ConverterPropertyEditorFactory.DisposableClassLoader

A custom class loader for the definition of the generated classes. When the generated class is loaded, it will need to be able to resolve both the base class (ConverterPropertyEditorBase) which comes from myLoader and the target class which comes from targetLoader. This class loader defines only the generated class, and delegates to the above two loaders for the rest.

The ConverterPropertyEditorFactory will keep a cache of these class loaders (via weak references), one for each class loader that the target classes come from. That way the target class loader (which is likely to be a webapp specific loader) can be disposed of and replaced when the webapp is removed or reinstalled.

Field Summary

Modifier and Type	Field and Description
private final ClassLoader	myLoader
private final ClassLoader	targetLoader

Constructor Summary

Access	Constructor and Description
public	DisposableClassLoader(ClassLoader targetLoader)

Method Summary

Modifier and Type	Method and Description
protected Class<?>	findClass(String The binary name of the class className) Overrides java.lang.ClassLoader.findClass. If `super.loadClass` is unable to locate a class, it will call this method to define it.
protected synchronized Class<?>	loadClass(String The binary name of the class name, boolean If `true` then resolve the class resolve) Overrides java.lang.ClassLoader.loadClass. Override class loading to enable possible delegation to the two class loaders, rather than just to the parent.

Field Detail

myLoader	back to summary
private final ClassLoader myLoader

targetLoader	back to summary
private final ClassLoader targetLoader

Constructor Detail

DisposableClassLoader	back to summary
public DisposableClassLoader(ClassLoader targetLoader)

Method Detail

findClass back to summary

protected Class<?> findClass(String className) throws ClassNotFoundException

Overrides java.lang.ClassLoader.findClass.

If super.loadClass is unable to locate a class, it will call this method to define it. If the className is a generated PropertyEditor class name, then create the new class. Otherwise call super.findClass which will throw a ClassNotFoundException.

Parameters

className:String

Doc from java.lang.ClassLoader.findClass.

The binary name of the class

Returns:Class<?>