Top Description Fields Constructors Methods
org.apache.tomcat.util.digester

public Class FactoryCreateRule

extends Rule
Class Inheritance
Imports
org.xml.sax.Attributes

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 scenario 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

Modifier and TypeField and Description
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.

private ArrayStack<Boolean>
exceptionIgnoredStack

Stock to manage

private boolean
ignoreCreateExceptions

Should exceptions thrown by the factory be ignored?

Inherited from org.apache.tomcat.util.digester.Rule:
digesternamespaceURIsm

Constructor Summary

AccessConstructor and Description
public
FactoryCreateRule(ObjectCreationFactory
called on to create the object.
creationFactory
,
boolean
if true, exceptions thrown by the object creation factory will be ignored.
ignoreCreateExceptions
)

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

Method Summary

Modifier and TypeMethod and Description
public void
begin(String
the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
namespace
,
String
the local name if the parser is namespace aware, or just the element name otherwise
name
,
Attributes
The attribute list of this element
attributes
)

Overrides org.apache.tomcat.util.digester.Rule.begin.

Process the beginning of this element.

public void
end(String
the namespace URI of the matching element, or an empty string if the parser is not namespace aware or the element has no namespace
namespace
,
String
the local name if the parser is namespace aware, or just the element name otherwise
name
)

Overrides org.apache.tomcat.util.digester.Rule.end.

Process the end of this element.

public void
finish()

Overrides org.apache.tomcat.util.digester.Rule.finish.

Clean up after parsing is complete.

public String
toString()

Overrides java.lang.Object.toString.

Render a printable version of this Rule.

Inherited from org.apache.tomcat.util.digester.Rule:
bodygetDigestergetNamespaceURIsetDigestersetNamespaceURI

Field Detail

creationFactoryback to summary
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.

exceptionIgnoredStackback to summary
private ArrayStack<Boolean> exceptionIgnoredStack

Stock to manage

ignoreCreateExceptionsback to summary
private boolean ignoreCreateExceptions

Should exceptions thrown by the factory be ignored?

Constructor Detail

FactoryCreateRuleback to summary
public FactoryCreateRule(ObjectCreationFactory creationFactory, boolean ignoreCreateExceptions)

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

Parameters
creationFactory:ObjectCreationFactory

called on to create the object.

ignoreCreateExceptions:boolean

if true, exceptions thrown by the object creation factory will be ignored.

Method Detail

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

Overrides org.apache.tomcat.util.digester.Rule.begin.

Process the beginning of this element.

Parameters
namespace:String

Doc from org.apache.tomcat.util.digester.Rule.begin.

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:String

Doc from org.apache.tomcat.util.digester.Rule.begin.

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

attributes:Attributes

The attribute list of this element

Annotations
@Override
Exceptions
Exception:

Doc from org.apache.tomcat.util.digester.Rule.begin.

if an error occurs while processing the event

endback to summary
public void end(String namespace, String name) throws Exception

Overrides org.apache.tomcat.util.digester.Rule.end.

Process the end of this element.

Parameters
namespace:String

Doc from org.apache.tomcat.util.digester.Rule.end.

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:String

Doc from org.apache.tomcat.util.digester.Rule.end.

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

Annotations
@Override
Exceptions
Exception:

Doc from org.apache.tomcat.util.digester.Rule.end.

if an error occurs while processing the event

finishback to summary
public void finish() throws Exception

Overrides org.apache.tomcat.util.digester.Rule.finish.

Clean up after parsing is complete.

Annotations
@Override
Exceptions
Exception:

Doc from org.apache.tomcat.util.digester.Rule.finish.

if an error occurs while processing the event

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Render a printable version of this Rule.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object

Annotations
@Override