org.apache.tomcat.util.digester

Class 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
protected StringattributeName
The attribute containing an override class name if it is present.
protected StringclassName
The Java class name of the ObjectCreationFactory to be created.
protected ObjectCreationFactorycreationFactory
The object creation factory we will use to instantiate objects as required based on the attributes specified in the matched XML element.
Constructor Summary
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.
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.
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.
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.
FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory)
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.

Exceptions thrown during the object creation process will be propagated.

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.

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.

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.

FactoryCreateRule(ObjectCreationFactory creationFactory)

Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.

Exceptions thrown during the object creation process will be propagated.

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(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(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.
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, boolean ignoreCreateExceptions)
Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.
Method Summary
voidbegin(String namespace, String name, Attributes attributes)
Process the beginning of this element.
voidend(String namespace, String name)
Process the end of this element.
voidfinish()
Clean up after parsing is complete.
protected ObjectCreationFactorygetFactory(Attributes attributes)
Return an instance of our associated object creation factory, creating one if necessary.
StringtoString()
Render a printable version of this Rule.

Field Detail

attributeName

protected String attributeName
The attribute containing an override class name if it is present.

className

protected 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(Digester digester, String className)

Deprecated: The digester instance is now set in the Digester method. Use FactoryCreateRule instead.

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: digester The associated Digester className Java class name of the object creation factory class

FactoryCreateRule

public FactoryCreateRule(Digester digester, Class clazz)

Deprecated: The digester instance is now set in the Digester method. Use FactoryCreateRule instead.

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: digester The associated Digester clazz Java class name of the object creation factory class

FactoryCreateRule

public FactoryCreateRule(Digester digester, String className, String attributeName)

Deprecated: The digester instance is now set in the Digester method. Use FactoryCreateRule instead.

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 className Default Java class name of the factory class attributeName Attribute name which, if present, contains an override of the class name of the object creation factory to create.

FactoryCreateRule

public FactoryCreateRule(Digester digester, Class clazz, String attributeName)

Deprecated: The digester instance is now set in the Digester method. Use FactoryCreateRule instead.

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 clazz Default Java class name of the factory class attributeName Attribute name which, if present, contains an override of the class name of the object creation factory to create.

FactoryCreateRule

public FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory)

Deprecated: The digester instance is now set in the Digester method. Use FactoryCreateRule instead.

Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.

Parameters: digester The associated Digester creationFactory called on to create the object.

FactoryCreateRule

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.

Parameters: className Java class name of the object creation factory class

FactoryCreateRule

public 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.

Parameters: clazz Java class name of the object creation factory class

FactoryCreateRule

public 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.

Parameters: className Default Java class name of the factory class attributeName Attribute name which, if present, contains an override of the class name of the object creation factory to create.

FactoryCreateRule

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.

Parameters: clazz Default Java class name of the factory class attributeName 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(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.

Parameters: className Java class name of the object creation factory class ignoreCreateExceptions if true, exceptions thrown by the object creation factory will be ignored.

FactoryCreateRule

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.

Parameters: clazz Java class name of the object creation factory class ignoreCreateExceptions if true, exceptions thrown by the object creation factory will be ignored.

FactoryCreateRule

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.

Parameters: className Default Java class name of the factory class attributeName 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(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.

Parameters: clazz Default Java class name of the factory class attributeName 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(String namespace, String name, Attributes attributes)
Process the beginning of this element.

Parameters: attributes The attribute list of this element

end

public void end(String namespace, String name)
Process the end of this element.

finish

public void finish()
Clean up after parsing is complete.

getFactory

protected ObjectCreationFactory getFactory(Attributes attributes)
Return an instance of our associated object creation factory, creating one if necessary.

Parameters: attributes Attributes passed to our factory creation element

Throws: Exception if any error occurs

toString

public String toString()
Render a printable version of this Rule.
Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.