| java.lang.Object
 org.apache.commons.digester.Rule
org.apache.commons.digester.FactoryCreateRule
| FactoryCreateRule | | public class FactoryCreateRule extends Rule (Code) | | Rule implementation that uses an
ObjectCreationFactory to create
a new object which it pushes onto the object stack. When the element is
complete, the object will be popped.
This rule is intended in situations where the element's attributes are
needed before the object can be created. A common senario is for the
ObjectCreationFactory implementation to use the attributes as parameters
in a call to either a factory method or to a non-empty constructor.
|
| Field Summary | |
| protected String | attributeName
The attribute containing an override class name if it is present. | | protected String | className
The Java class name of the ObjectCreationFactory to be created. | | protected ObjectCreationFactory | creationFactory
The object creation factory we will use to instantiate objects
as required based on the attributes specified in the matched XML
element. |
| Constructor Summary | |
| public | FactoryCreateRule(Digester digester, String className)
Construct a factory create rule that will use the specified
class name to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack. | | public | FactoryCreateRule(Digester digester, Class clazz)
Construct a factory create rule that will use the specified
class to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack. | | public | FactoryCreateRule(Digester digester, String className, String attributeName)
Construct a factory create rule that will use the specified
class name (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack. | | public | FactoryCreateRule(Digester digester, Class clazz, String attributeName)
Construct a factory create rule that will use the specified
class (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack. | | public | FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory)
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory . | | public | FactoryCreateRule(String className)
| | public | FactoryCreateRule(Class clazz)
| | public | FactoryCreateRule(String className, String attributeName)
| | public | FactoryCreateRule(Class clazz, String attributeName)
| | public | FactoryCreateRule(ObjectCreationFactory creationFactory)
| | public | FactoryCreateRule(String className, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified
class name to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack. | | public | FactoryCreateRule(Class clazz, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified
class to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack. | | public | FactoryCreateRule(String className, String attributeName, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified
class name (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack. | | public | FactoryCreateRule(Class clazz, String attributeName, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified
class (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack. | | public | FactoryCreateRule(ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory . |
| attributeName | | protected String attributeName(Code) | | The attribute containing an override class name if it is present.
|
| className | | protected String className(Code) | | The Java class name of the ObjectCreationFactory to be created.
This class must have a no-arguments constructor.
|
| creationFactory | | protected ObjectCreationFactory creationFactory(Code) | | The object creation factory we will use to instantiate objects
as required based on the attributes specified in the matched XML
element.
|
| FactoryCreateRule | | public FactoryCreateRule(Digester digester, String className, String attributeName)(Code) | | Construct a factory create rule that will use the specified
class name (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Parameters:
digester - The associated Digester
Parameters:
className - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create.Digester.addRuleFactoryCreateRule.FactoryCreateRule(String className,String attributeName) |
| FactoryCreateRule | | public FactoryCreateRule(Digester digester, Class clazz, String attributeName)(Code) | | Construct a factory create rule that will use the specified
class (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Parameters:
digester - The associated Digester
Parameters:
clazz - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create.Digester.addRuleFactoryCreateRule.FactoryCreateRule(Class clazz,String attributeName) |
| FactoryCreateRule | | public FactoryCreateRule(String className)(Code) | | Construct a factory create rule that will use the specified
class name to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack.
Exceptions thrown during the object creation process will be propagated.
Parameters:
className - Java class name of the object creation factory class |
| FactoryCreateRule | | public FactoryCreateRule(Class clazz)(Code) | | Construct a factory create rule that will use the specified
class to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack.
Exceptions thrown during the object creation process will be propagated.
Parameters:
clazz - Java class name of the object creation factory class |
| FactoryCreateRule | | public FactoryCreateRule(String className, String attributeName)(Code) | | Construct a factory create rule that will use the specified
class name (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Exceptions thrown during the object creation process will be propagated.
Parameters:
className - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create. |
| FactoryCreateRule | | public FactoryCreateRule(Class clazz, String attributeName)(Code) | | Construct a factory create rule that will use the specified
class (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Exceptions thrown during the object creation process will be propagated.
Parameters:
clazz - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create. |
| FactoryCreateRule | | public FactoryCreateRule(ObjectCreationFactory creationFactory)(Code) | | Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory .
Exceptions thrown during the object creation process will be propagated.
Parameters:
creationFactory - called on to create the object. |
| FactoryCreateRule | | public FactoryCreateRule(String className, boolean ignoreCreateExceptions)(Code) | | Construct a factory create rule that will use the specified
class name to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack.
Parameters:
className - Java class name of the object creation factory class
Parameters:
ignoreCreateExceptions - if true, exceptions thrown by the objectcreation factorywill be ignored. |
| FactoryCreateRule | | public FactoryCreateRule(Class clazz, boolean ignoreCreateExceptions)(Code) | | Construct a factory create rule that will use the specified
class to create an
ObjectCreationFactory which will
then be used to create an object and push it on the stack.
Parameters:
clazz - Java class name of the object creation factory class
Parameters:
ignoreCreateExceptions - if true, exceptions thrown by theobject creation factorywill be ignored. |
| FactoryCreateRule | | public FactoryCreateRule(String className, String attributeName, boolean ignoreCreateExceptions)(Code) | | Construct a factory create rule that will use the specified
class name (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Parameters:
className - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create.
Parameters:
ignoreCreateExceptions - if true, exceptions thrown by the objectcreation factory will be ignored. |
| FactoryCreateRule | | public FactoryCreateRule(Class clazz, String attributeName, boolean ignoreCreateExceptions)(Code) | | Construct a factory create rule that will use the specified
class (possibly overridden by the specified attribute if present)
to create an
ObjectCreationFactory , which will then be used
to instantiate an object instance and push it onto the stack.
Parameters:
clazz - Default Java class name of the factory class
Parameters:
attributeName - Attribute name which, if present, contains anoverride of the class name of the object creation factory to create.
Parameters:
ignoreCreateExceptions - if true, exceptions thrown by the objectcreation factory will be ignored. |
| FactoryCreateRule | | public FactoryCreateRule(ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)(Code) | | Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory .
Parameters:
creationFactory - called on to create the object.
Parameters:
ignoreCreateExceptions - if true, exceptions thrown by the objectcreation factory will be ignored. |
| begin | | public void begin(String namespace, String name, Attributes attributes) throws Exception(Code) | | Process the beginning of this element.
Parameters:
attributes - The attribute list of this element |
| finish | | public void finish() throws Exception(Code) | | Clean up after parsing is complete.
|
| getFactory | | protected ObjectCreationFactory getFactory(Attributes attributes) throws Exception(Code) | | Return an instance of our associated object creation factory,
creating one if necessary.
Parameters:
attributes - Attributes passed to our factory creation element
exception:
Exception - if any error occurs |
| toString | | public String toString()(Code) | | Render a printable version of this Rule.
|
|
|