Package org.apache.commons.digester

Class ObjectCreateRule

java.lang.Object

org.apache.commons.digester.Rule

org.apache.commons.digester.ObjectCreateRule

public class ObjectCreateRule
extends Rule

Rule implementation that creates a new object and pushes it onto the object stack. When the element is complete, the object will be popped

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 object to be created.

Fields inherited from class org.apache.commons.digester.Rule

digester, namespaceURI

Constructor Summary

Constructors

Constructor	Description
ObjectCreateRule(java.lang.Class<?> clazz)	Construct an object create rule with the specified class.
ObjectCreateRule(java.lang.String className)	Construct an object create rule with the specified class name.
ObjectCreateRule(java.lang.String attributeName, java.lang.Class<?> clazz)	Construct an object create rule with the specified class and an optional attribute name containing an override.
ObjectCreateRule(java.lang.String className, java.lang.String attributeName)	Construct an object create rule with the specified class name and an optional attribute name containing an override.
ObjectCreateRule(Digester digester, java.lang.Class<?> clazz)	Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(Class clazz) instead.
ObjectCreateRule(Digester digester, java.lang.String className)	Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String className) instead.
ObjectCreateRule(Digester digester, java.lang.String attributeName, java.lang.Class<?> clazz)	Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String attributeName, Class clazz) instead.
ObjectCreateRule(Digester digester, java.lang.String className, java.lang.String attributeName)	Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String className, String attributeName) instead.

Method Summary

Modifier and Type	Method	Description
void	begin(org.xml.sax.Attributes attributes)	Process the beginning of this element.
void	end()	Process the end of this element.
java.lang.String	toString()	Render a printable version of this Rule.

Methods inherited from class java.lang.Object

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

Methods inherited from class org.apache.commons.digester.Rule

begin, body, body, end, finish, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Field Detail

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 object to be created.

Constructor Detail

ObjectCreateRule

@Deprecated
public ObjectCreateRule(Digester digester,
                        java.lang.String className)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String className) instead.

Construct an object create rule with the specified class name.

Parameters:

digester - The associated Digester

className - Java class name of the object to be created

ObjectCreateRule

@Deprecated
public ObjectCreateRule(Digester digester,
                        java.lang.Class<?> clazz)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(Class clazz) instead.

Construct an object create rule with the specified class.

Parameters:

digester - The associated Digester

clazz - Java class name of the object to be created

ObjectCreateRule

@Deprecated
public ObjectCreateRule(Digester digester,
                        java.lang.String className,
                        java.lang.String attributeName)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String className, String attributeName) instead.

Construct an object create rule with the specified class name and an optional attribute name containing an override.

Parameters:

digester - The associated Digester

className - Java class name of the object to be created

attributeName - Attribute name which, if present, contains an override of the class name to create

ObjectCreateRule

@Deprecated
public ObjectCreateRule(Digester digester,
                        java.lang.String attributeName,
                        java.lang.Class<?> clazz)

Deprecated. The digester instance is now set in the Digester.addRule(java.lang.String, org.apache.commons.digester.Rule) method. Use ObjectCreateRule(String attributeName, Class clazz) instead.

Construct an object create rule with the specified class and an optional attribute name containing an override.

Parameters:

digester - The associated Digester

attributeName - Attribute name which, if present, contains an

clazz - Java class name of the object to be created override of the class name to create

ObjectCreateRule

public ObjectCreateRule(java.lang.String className)

Construct an object create rule with the specified class name.

Parameters:

className - Java class name of the object to be created

ObjectCreateRule

public ObjectCreateRule(java.lang.Class<?> clazz)

Construct an object create rule with the specified class.

Parameters:

clazz - Java class name of the object to be created

ObjectCreateRule

public ObjectCreateRule(java.lang.String className,
                        java.lang.String attributeName)

Construct an object create rule with the specified class name and an optional attribute name containing an override.

Parameters:

className - Java class name of the object to be created

attributeName - Attribute name which, if present, contains an override of the class name to create

ObjectCreateRule

public ObjectCreateRule(java.lang.String attributeName,
                        java.lang.Class<?> clazz)

Construct an object create rule with the specified class and an optional attribute name containing an override.

Parameters:

attributeName - Attribute name which, if present, contains an

clazz - Java class name of the object to be created override of the class name to create

Method Detail

begin

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

Process the beginning of this element.

Overrides:

begin in class Rule

Parameters:

attributes - The attribute list of this element

Throws:

java.lang.Exception

end

public void end()
         throws java.lang.Exception

Process the end of this element.

Overrides:

end in class Rule

Throws:

java.lang.Exception

toString

public java.lang.String toString()

Render a printable version of this Rule.

Overrides:

toString in class java.lang.Object