org.apache.tomcat.util.digester

Interface Rules

public interface Rules

Public interface defining a collection of Rule instances (and corresponding matching patterns) plus an implementation of a matching policy that selects the rules that match a particular pattern of nested elements discovered during parsing.
Method Summary
voidadd(String pattern, Rule rule)
Register a new Rule instance matching the specified pattern.
voidclear()
Clear all existing Rule instance registrations.
DigestergetDigester()
Return the Digester instance with which this Rules instance is associated.
StringgetNamespaceURI()
Return the namespace URI that will be applied to all subsequently added Rule objects.
Listmatch(String pattern)
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
Listmatch(String namespaceURI, String pattern)
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches.
Listrules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances.
voidsetDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.
voidsetNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently added Rule objects.

Method Detail

add

public void add(String pattern, Rule rule)
Register a new Rule instance matching the specified pattern.

Parameters: pattern Nesting pattern to be matched for this Rule rule Rule instance to be registered

clear

public void clear()
Clear all existing Rule instance registrations.

getDigester

public Digester getDigester()
Return the Digester instance with which this Rules instance is associated.

getNamespaceURI

public String getNamespaceURI()
Return the namespace URI that will be applied to all subsequently added Rule objects.

match

public List match(String pattern)

Deprecated: Call match(namespaceURI,pattern) instead.

Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches. If more than one Rule instance matches, they must be returned in the order originally registered through the add() method.

Parameters: pattern Nesting pattern to be matched

match

public List match(String namespaceURI, String pattern)
Return a List of all registered Rule instances that match the specified nesting pattern, or a zero-length List if there are no matches. If more than one Rule instance matches, they must be returned in the order originally registered through the add() method.

Parameters: namespaceURI Namespace URI for which to select matching rules, or null to match regardless of namespace URI pattern Nesting pattern to be matched

rules

public List rules()
Return a List of all registered Rule instances, or a zero-length List if there are no registered Rule instances. If more than one Rule instance has been registered, they must be returned in the order originally registered through the add() method.

setDigester

public void setDigester(Digester digester)
Set the Digester instance with which this Rules instance is associated.

Parameters: digester The newly associated Digester instance

setNamespaceURI

public void setNamespaceURI(String namespaceURI)
Set the namespace URI that will be applied to all subsequently added Rule objects.

Parameters: namespaceURI Namespace URI that must match on all subsequently added rules, or null for matching regardless of the current namespace URI

Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.