Class FactoryCreateRule
- java.lang.Object
-
- org.apache.commons.digester3.Rule
-
- org.apache.commons.digester3.FactoryCreateRule
-
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 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
Fields Modifier and Type Field Description protected java.lang.String
attributeName
The attribute containing an override class name if it is present.protected java.lang.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.private java.util.Stack<java.lang.Boolean>
exceptionIgnoredStack
Stock to manageprivate boolean
ignoreCreateExceptions
Should exceptions thrown by the factory be ignored?
-
Constructor Summary
Constructors Constructor Description FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz)
Construct a factory create rule that will use the specified class to create anObjectCreationFactory
which will then be used to create an object and push it on the stack.FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified class to create anObjectCreationFactory
which will then be used to create an object and push it on the stack.FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, java.lang.String attributeName)
Construct a factory create rule that will use the specified class (possibly overridden by the specified attribute if present) to create anObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack.FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, java.lang.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 anObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack.FactoryCreateRule(java.lang.String className)
Construct a factory create rule that will use the specified class name to create anObjectCreationFactory
which will then be used to create an object and push it on the stack.FactoryCreateRule(java.lang.String className, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified class name to create anObjectCreationFactory
which will then be used to create an object and push it on the stack.FactoryCreateRule(java.lang.String className, java.lang.String attributeName)
Construct a factory create rule that will use the specified class name (possibly overridden by the specified attribute if present) to create anObjectCreationFactory
, which will then be used to instantiate an object instance and push it onto the stack.FactoryCreateRule(java.lang.String className, java.lang.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 anObjectCreationFactory
, 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
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
begin(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes)
This method is called when the beginning of a matching XML element is encountered.void
end(java.lang.String namespace, java.lang.String name)
This method is called when the end of a matching XML element is encountered.void
finish()
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.protected ObjectCreationFactory<?>
getFactory(org.xml.sax.Attributes attributes)
Return an instance of our associated object creation factory, creating one if necessary.java.lang.String
toString()
-
Methods inherited from class org.apache.commons.digester3.Rule
body, getDigester, getNamespaceURI, setDigester, setNamespaceURI
-
-
-
-
Field Detail
-
ignoreCreateExceptions
private boolean ignoreCreateExceptions
Should exceptions thrown by the factory be ignored?
-
exceptionIgnoredStack
private java.util.Stack<java.lang.Boolean> exceptionIgnoredStack
Stock to manage
-
attributeName
protected java.lang.String attributeName
The attribute containing an override class name if it is present.
-
className
protected java.lang.String className
The Java class name of the ObjectCreationFactory to be created. This class must have a no-arguments constructor.
-
creationFactory
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 Detail
-
FactoryCreateRule
public FactoryCreateRule(java.lang.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.
- Parameters:
className
- Java class name of the object creation factory class
-
FactoryCreateRule
public FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> 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.
- Parameters:
clazz
- Java class name of the object creation factory class
-
FactoryCreateRule
public FactoryCreateRule(java.lang.String className, java.lang.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.
- Parameters:
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.
-
FactoryCreateRule
public FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, java.lang.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.
- Parameters:
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.
-
FactoryCreateRule
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.
- Parameters:
creationFactory
- called on to create the object.
-
FactoryCreateRule
public FactoryCreateRule(java.lang.String className, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified class name to create anObjectCreationFactory
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 classignoreCreateExceptions
- if true, exceptions thrown by the object creation factory will be ignored.
-
FactoryCreateRule
public FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, boolean ignoreCreateExceptions)
Construct a factory create rule that will use the specified class to create anObjectCreationFactory
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 classignoreCreateExceptions
- if true, exceptions thrown by the object creation factory will be ignored.
-
FactoryCreateRule
public FactoryCreateRule(java.lang.String className, java.lang.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 anObjectCreationFactory
, 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 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.
-
FactoryCreateRule
public FactoryCreateRule(java.lang.Class<? extends ObjectCreationFactory<?>> clazz, java.lang.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 anObjectCreationFactory
, 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 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.
-
FactoryCreateRule
public FactoryCreateRule(ObjectCreationFactory<?> creationFactory, boolean ignoreCreateExceptions)
Construct a factory create rule using the given, already instantiated,ObjectCreationFactory
.- Parameters:
creationFactory
- called on to create the object.ignoreCreateExceptions
- if true, exceptions thrown by the object creation factory will be ignored.
-
-
Method Detail
-
begin
public void begin(java.lang.String namespace, java.lang.String name, org.xml.sax.Attributes attributes) throws java.lang.Exception
This method is called when the beginning of a matching XML element is encountered.- Overrides:
begin
in classRule
- Parameters:
namespace
- 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 otherwiseattributes
- The attribute list of this element- Throws:
java.lang.Exception
- if any error occurs
-
end
public void end(java.lang.String namespace, java.lang.String name) throws java.lang.Exception
This method is called when the end of a matching XML element is encountered.- Overrides:
end
in classRule
- Parameters:
namespace
- 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 otherwise- Throws:
java.lang.Exception
- if any error occurs
-
finish
public void finish() throws java.lang.Exception
This method is called after all parsing methods have been called, to allow Rules to remove temporary data.
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
getFactory
protected ObjectCreationFactory<?> getFactory(org.xml.sax.Attributes attributes) throws java.lang.Exception
Return an instance of our associated object creation factory, creating one if necessary.- Parameters:
attributes
- Attributes passed to our factory creation element- Returns:
- An instance of our associated object creation factory, creating one if necessary
- Throws:
java.lang.Exception
- if any error occurs
-
-