Home » commons-digester-1.8-src » org.apache.commons » digester » [javadoc | source]

org.apache.commons.digester
public class: FactoryCreateRule [javadoc | source]

java.lang.Object
   org.apache.commons.digester.Rule
      org.apache.commons.digester.FactoryCreateRule

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. This class must have a no-arguments constructor.
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.

Fields inherited from org.apache.commons.digester.Rule:
digester,  namespaceURI

Constructor:
public FactoryCreateRule(String className) { this(className, false); } 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
public FactoryCreateRule(Class clazz) { this(clazz, false); } 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
public FactoryCreateRule(ObjectCreationFactory creationFactory) { this(creationFactory, false); } 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.
public FactoryCreateRule(Digester digester, String className) { this(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. Parameters: digester - The associated Digester className - Java class name of the object creation factory class
public FactoryCreateRule(Digester digester, Class clazz) { this(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. Parameters: digester - The associated Digester clazz - Java class name of the object creation factory class
public FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory) { this(creationFactory); } Construct a factory create rule using the given, already instantiated, ObjectCreationFactory . Parameters: digester - The associated Digester creationFactory - called on to create the object.
public FactoryCreateRule(String className, String attributeName) { this(className, attributeName, false); } 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.
public FactoryCreateRule(Class clazz, String attributeName) { this(clazz, attributeName, false); } 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.
public FactoryCreateRule(String className, boolean ignoreCreateExceptions) { this(className, null, 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.
public FactoryCreateRule(Class clazz, boolean ignoreCreateExceptions) { this(clazz, null, 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.
public FactoryCreateRule(ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions) { this.creationFactory = creationFactory; this.ignoreCreateExceptions = 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.
public FactoryCreateRule(Digester digester, String className, String attributeName) { this(className, 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. 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.
public FactoryCreateRule(Digester digester, Class clazz, String attributeName) { this(clazz, 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. 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.
public FactoryCreateRule(String className, String attributeName, boolean ignoreCreateExceptions) { this.className = className; this.attributeName = attributeName; this.ignoreCreateExceptions = 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.
public FactoryCreateRule(Class clazz, String attributeName, boolean ignoreCreateExceptions) { this(clazz.getName(), attributeName, 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.

Method from org.apache.commons.digester.FactoryCreateRule Summary:
begin,   end,   finish,   getFactory,   toString

Methods from org.apache.commons.digester.Rule:
begin,   begin,   body,   body,   end,   end,   finish,   getDigester,   getNamespaceURI,   setDigester,   setNamespaceURI

Methods from java.lang.Object:
equals,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait

Method from org.apache.commons.digester.FactoryCreateRule Detail:
public void begin(String namespace, String name, Attributes attributes) throws Exception { // --------------------------------------------------------- Public Methods if (ignoreCreateExceptions) { if (exceptionIgnoredStack == null) { exceptionIgnoredStack = new ArrayStack(); } try { Object instance = getFactory(attributes).createObject(attributes); if (digester.log.isDebugEnabled()) { digester.log.debug("[FactoryCreateRule]{" + digester.match + "} New " + instance.getClass().getName()); } digester.push(instance); exceptionIgnoredStack.push(Boolean.FALSE); } catch (Exception e) { // log message and error if (digester.log.isInfoEnabled()) { digester.log.info("[FactoryCreateRule] Create exception ignored: " + ((e.getMessage() == null) ? e.getClass().getName() : e.getMessage())); if (digester.log.isDebugEnabled()) { digester.log.debug("[FactoryCreateRule] Ignored exception:", e); } } exceptionIgnoredStack.push(Boolean.TRUE); } } else { Object instance = getFactory(attributes).createObject(attributes); if (digester.log.isDebugEnabled()) { digester.log.debug("[FactoryCreateRule]{" + digester.match + "} New " + instance.getClass().getName()); } digester.push(instance); } } Process the beginning of this element.
public void end(String namespace, String name) throws Exception { // check if object was created // this only happens if an exception was thrown and we're ignoring them if ( ignoreCreateExceptions && exceptionIgnoredStack != null && !(exceptionIgnoredStack.empty())) { if (((Boolean) exceptionIgnoredStack.pop()).booleanValue()) { // creation exception was ignored // nothing was put onto the stack if (digester.log.isTraceEnabled()) { digester.log.trace("[FactoryCreateRule] No creation so no push so no pop"); } return; } } Object top = digester.pop(); if (digester.log.isDebugEnabled()) { digester.log.debug("[FactoryCreateRule]{" + digester.match + "} Pop " + top.getClass().getName()); } } Process the end of this element.
public void finish() throws Exception { if (attributeName != null) { creationFactory = null; } } Clean up after parsing is complete.
protected ObjectCreationFactory getFactory(Attributes attributes) throws Exception { if (creationFactory == null) { String realClassName = className; if (attributeName != null) { String value = attributes.getValue(attributeName); if (value != null) { realClassName = value; } } if (digester.log.isDebugEnabled()) { digester.log.debug("[FactoryCreateRule]{" + digester.match + "} New factory " + realClassName); } Class clazz = digester.getClassLoader().loadClass(realClassName); creationFactory = (ObjectCreationFactory) clazz.newInstance(); creationFactory.setDigester(digester); } return (creationFactory); } Return an instance of our associated object creation factory, creating one if necessary.
public String toString() { StringBuffer sb = new StringBuffer("FactoryCreateRule["); sb.append("className="); sb.append(className); sb.append(", attributeName="); sb.append(attributeName); if (creationFactory != null) { sb.append(", creationFactory="); sb.append(creationFactory); } sb.append("]"); return (sb.toString()); } Render a printable version of this Rule.