Class NodeCreateRuleProvider

java.lang.Object

org.apache.commons.digester3.binder.AbstractBackToLinkedRuleBuilder<NodeCreateRule>

org.apache.commons.digester3.binder.NodeCreateRuleProvider

All Implemented Interfaces:

RuleProvider<NodeCreateRule>

public final class NodeCreateRuleProvider
extends AbstractBackToLinkedRuleBuilder<NodeCreateRule>

Builder chained when invoking LinkedRuleBuilder.createNode().

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	NodeCreateRuleProvider.NodeType	Enumeration that wraps admitted Node node constants.

Field Summary

Fields

Modifier and Type	Field	Description
private DocumentBuilder	documentBuilder
private NodeCreateRuleProvider.NodeType	nodeType

Constructor Summary

Constructors

Constructor	Description
NodeCreateRuleProvider(String keyPattern, String namespaceURI, RulesBinder mainBinder, LinkedRuleBuilder mainBuilder)

Method Summary

Modifier and Type	Method	Description
protected NodeCreateRule	createRule()	Provides an instance of Rule.
NodeCreateRuleProvider	ofType(NodeCreateRuleProvider.NodeType nodeType)	NodeCreateRule instance will be created either a DOM Element or a DOM DocumentFragment, depending on the value of the nodeType parameter.
NodeCreateRuleProvider	usingDocumentBuilder(DocumentBuilder documentBuilder)	NodeCreateRule instance will be created a DOM Element, but lets users specify the JAXP DocumentBuilder that should be used when constructing the node tree.

Methods inherited from class AbstractBackToLinkedRuleBuilder

get, getNamespaceURI, getPattern, reportError, then

Methods inherited from class Object

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

Field Details

nodeType

private NodeCreateRuleProvider.NodeType nodeType

documentBuilder

private DocumentBuilder documentBuilder

Constructor Details

NodeCreateRuleProvider

NodeCreateRuleProvider(String keyPattern,
 String namespaceURI,
 RulesBinder mainBinder,
 LinkedRuleBuilder mainBuilder)

Method Details

ofType

public NodeCreateRuleProvider ofType(NodeCreateRuleProvider.NodeType nodeType)

NodeCreateRule instance will be created either a DOM Element or a DOM DocumentFragment, depending on the value of the nodeType parameter.

Parameters:

nodeType - the type of node to create, which can be either Node.ELEMENT_NODE or Node.DOCUMENT_FRAGMENT_NODE

Returns:

this builder instance

usingDocumentBuilder

public NodeCreateRuleProvider usingDocumentBuilder(DocumentBuilder documentBuilder)

NodeCreateRule instance will be created a DOM Element, but lets users specify the JAXP DocumentBuilder that should be used when constructing the node tree.

Parameters:

documentBuilder - the JAXP DocumentBuilder to use

Returns:

this builder instance

createRule

protected NodeCreateRule createRule()

Provides an instance of Rule. Must never return null.

Specified by:

createRule in class AbstractBackToLinkedRuleBuilder<NodeCreateRule>

Returns:

an instance of Rule.

See Also:

• AbstractBackToLinkedRuleBuilder.get()