com.sun.faces.config.rules

Class DescriptionTextRule

java.lang.Object

org.apache.commons.digester.Rule

org.apache.commons.digester.NodeCreateRule

com.sun.faces.config.rules.DescriptionTextRule

public class DescriptionTextRule
extends org.apache.commons.digester.NodeCreateRule

Digester rule for the <description> element, used to absorb the body content of the matching element even if it contains mixed markup and body content, and then save it as the value of the description property of the corresponding DescriptionBean instance..

Field Summary

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

digester, namespaceURI

Constructor Summary

Constructors

Constructor and Description
DescriptionTextRule() Construct a variant of NodeCreateRule that will create a DocumentFragment object.

Method Summary

Modifier and Type	Method and Description
void	begin(String namespace, String name, Attributes attributes) Ensure that the object at the top of the stack is a DescriptionBean, then perform the standard superclass processing.
void	body(String namespace, String name, String text) No body processing is required.
void	end(String namespace, String name) Serialize the resulting DOM into text, and use it to set the description property of the parent DescriptionBean.
void	finish() No finish processing is required.
String	toString()

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

end

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

begin, body, getDigester, getNamespaceURI, setDigester, setNamespaceURI

Methods inherited from class java.lang.Object

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

Constructor Detail

DescriptionTextRule

public DescriptionTextRule()
                    throws Exception

Construct a variant of NodeCreateRule that will create a DocumentFragment object.

Throws:

Exception

Method Detail

begin

public void begin(String namespace,
                  String name,
                  Attributes attributes)
           throws Exception

Ensure that the object at the top of the stack is a DescriptionBean, then perform the standard superclass processing.

Overrides:

begin in class org.apache.commons.digester.NodeCreateRule

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 namespace

name - the local name if the parser is namespace aware, or just the element name otherwise

attributes - The attribute list of this element

Throws:

IllegalStateException - if the parent stack element is not of type FeatureBean

Exception

body

public void body(String namespace,
                 String name,
                 String text)
          throws Exception

No body processing is required.

Overrides:

body in class org.apache.commons.digester.Rule

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 namespace

name - the local name if the parser is namespace aware, or just the element name otherwise

text - The text of the body of this element

Throws:

Exception

end

public void end(String namespace,
                String name)
         throws Exception

Serialize the resulting DOM into text, and use it to set the description property of the parent DescriptionBean.

Overrides:

end in class org.apache.commons.digester.Rule

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 namespace

name - the local name if the parser is namespace aware, or just the element name otherwise

Throws:

IllegalStateException - if the popped object is not of the correct type

Exception

finish

public void finish()
            throws Exception

No finish processing is required.

Overrides:

finish in class org.apache.commons.digester.Rule

Throws:

Exception

toString

public String toString()

Overrides:

toString in class Object