org.apache.commons.digester
クラス FactoryCreateRule

java.lang.Object
  |
  +--org.apache.commons.digester.Rule
        |
        +--org.apache.commons.digester.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.

バージョン:

$Revision: 1.4 $ $Date: 2001/08/20 18:28:40 $

作成者:

Robert Burrell Donkin

フィールドの概要

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.

クラス org.apache.commons.digester.Rule から継承したフィールド

digester, namespaceURI

コンストラクタの概要

FactoryCreateRule(Digester digester, ObjectCreationFactory creationFactory)
Construct a factory create rule using the given, already instantiated, ObjectCreationFactory.

FactoryCreateRule(Digester digester, 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.

FactoryCreateRule(Digester digester, 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.

メソッドの概要

void	begin(org.xml.sax.Attributes attributes) Process the beginning of this element.
void	end() Process the end of this element.
void	finish() Clean up after parsing is complete.
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() Render a printable version of this Rule.

クラス org.apache.commons.digester.Rule から継承したメソッド

body, getDigester, getNamespaceURI, setNamespaceURI

クラス java.lang.Object から継承したメソッド

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, wait, wait, wait

フィールドの詳細

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.

コンストラクタの詳細

FactoryCreateRule

public FactoryCreateRule(Digester digester,
                         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.

パラメータ:

digester - The associated Digester

className - Java class name of the object creation factory class

FactoryCreateRule

public FactoryCreateRule(Digester digester,
                         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.

パラメータ:

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,
                         ObjectCreationFactory creationFactory)

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

パラメータ:

digester - The associated Digester

creationFactory - called on to create the object.

メソッドの詳細

begin

public void begin(org.xml.sax.Attributes attributes)
           throws java.lang.Exception

Process the beginning of this element.

オーバーライド:

クラス Rule 内の begin

パラメータ:

attributes - The attribute list of this element

end

public void end()
         throws java.lang.Exception

Process the end of this element.

オーバーライド:

クラス Rule 内の end

finish

public void finish()
            throws java.lang.Exception

Clean up after parsing is complete.

オーバーライド:

クラス Rule 内の finish

toString

public java.lang.String toString()

Render a printable version of this Rule.

オーバーライド:

クラス java.lang.Object 内の toString

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.

パラメータ:

attributes - Attributes passed to our factory creation element

例外:

java.lang.Exception - if any error occurs