public class FactoryCreateRule extends Rule
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 scenario 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.
| Modifier and Type | Field and Description |
|---|---|
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.
|
digester, namespaceURI| Constructor and Description |
|---|
FactoryCreateRule(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. |
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. |
FactoryCreateRule(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. |
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. |
FactoryCreateRule(ObjectCreationFactory creationFactory)
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory. |
FactoryCreateRule(ObjectCreationFactory creationFactory,
boolean ignoreCreateExceptions)
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory. |
FactoryCreateRule(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. |
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. |
FactoryCreateRule(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. |
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. |
| Modifier and Type | Method and Description |
|---|---|
void |
begin(String namespace,
String name,
Attributes attributes)
Process the beginning of this element.
|
void |
end(String namespace,
String name)
Process the end of this element.
|
void |
finish()
Clean up after parsing is complete.
|
protected ObjectCreationFactory |
getFactory(Attributes attributes)
Return an instance of our associated object creation factory,
creating one if necessary.
|
String |
toString()
Render a printable version of this Rule.
|
begin, body, body, end, getDigester, getNamespaceURI, setDigester, setNamespaceURIprotected String attributeName
protected String className
protected ObjectCreationFactory creationFactory
public FactoryCreateRule(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.
Exceptions thrown during the object creation process will be propagated.
className - Java class name of the object creation factory classpublic FactoryCreateRule(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.
Exceptions thrown during the object creation process will be propagated.
clazz - Java class name of the object creation factory classpublic FactoryCreateRule(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.
Exceptions thrown during the object creation process will be propagated.
className - Default Java class name of the factory classattributeName - Attribute name which, if present, contains an
override of the class name of the object creation factory to create.public FactoryCreateRule(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.
Exceptions thrown during the object creation process will be propagated.
clazz - Default Java class name of the factory classattributeName - Attribute name which, if present, contains an
override of the class name of the object creation factory to create.public FactoryCreateRule(ObjectCreationFactory creationFactory)
Construct a factory create rule using the given, already instantiated,
ObjectCreationFactory.
Exceptions thrown during the object creation process will be propagated.
creationFactory - called on to create the object.public FactoryCreateRule(String className, boolean ignoreCreateExceptions)
ObjectCreationFactory which will
then be used to create an object and push it on the stack.className - Java class name of the object creation factory classignoreCreateExceptions - if true, exceptions thrown by the object
creation factory
will be ignored.public FactoryCreateRule(Class<?> clazz, boolean ignoreCreateExceptions)
ObjectCreationFactory which will
then be used to create an object and push it on the stack.clazz - Java class name of the object creation factory classignoreCreateExceptions - if true, exceptions thrown by the
object creation factory
will be ignored.public FactoryCreateRule(String className, String attributeName, boolean ignoreCreateExceptions)
ObjectCreationFactory, which will then be used
to instantiate an object instance and push it onto the stack.className - Default Java class name of the factory classattributeName - Attribute name which, if present, contains an
override of the class name of the object creation factory to create.ignoreCreateExceptions - if true, exceptions thrown by the object
creation factory will be ignored.public FactoryCreateRule(Class<?> clazz, String attributeName, boolean ignoreCreateExceptions)
ObjectCreationFactory, which will then be used
to instantiate an object instance and push it onto the stack.clazz - Default Java class name of the factory classattributeName - Attribute name which, if present, contains an
override of the class name of the object creation factory to create.ignoreCreateExceptions - if true, exceptions thrown by the object
creation factory will be ignored.public FactoryCreateRule(ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)
ObjectCreationFactory.creationFactory - called on to create the object.ignoreCreateExceptions - if true, exceptions thrown by the object
creation factory will be ignored.public void begin(String namespace, String name, Attributes attributes) throws Exception
begin in class Ruleattributes - The attribute list of this elementnamespace - the namespace URI of the matching element, or an
empty string if the parser is not namespace aware or the element has
no namespacename - the local name if the parser is namespace aware, or just
the element name otherwiseExceptionpublic void end(String namespace, String name) throws Exception
public void finish()
throws Exception
public String toString()
protected ObjectCreationFactory getFactory(Attributes attributes) throws Exception
attributes - Attributes passed to our factory creation elementException - if any error occursCopyright © 2000-2021 Apache Software Foundation. All Rights Reserved.