Class ContextRuleSet

java/org/apache/catalina/startup/ContextRuleSet.java:25–194

RuleSet for processing the contents of a Context definition element.

 * <strong>RuleSet</strong> for processing the contents of a Context definition element.
 */
public class ContextRuleSet implements RuleSet {

    // ----------------------------------------------------- Instance Variables

    /**
     * The matching pattern prefix to use for recognizing our elements.
     */
    protected final String prefix;


    /**
     * Should the context be created.
     */
    protected final boolean create;


    // ------------------------------------------------------------ Constructor

    /**
     * Construct an instance of this <code>RuleSet</code> with the default matching pattern prefix.
     * The context instance will be created by the digester.
     */
    public ContextRuleSet() {
        this("");
    }


    /**
     * Construct an instance of this <code>RuleSet</code> with the specified matching pattern prefix.
     * The context instance will be created by the digester.
     *
     * @param prefix Prefix for matching pattern rules (including the trailing slash character)
     */
    public ContextRuleSet(String prefix) {
        this(prefix, true);
    }


    /**
     * Construct an instance of this <code>RuleSet</code> with the specified matching pattern prefix.
     *
     * @param prefix Prefix for matching pattern rules (including the trailing slash character)
     * @param create <code>true</code> if the main context instance should be created
     */
    public ContextRuleSet(String prefix, boolean create) {
        this.prefix = prefix;
        this.create = create;
    }


    // --------------------------------------------------------- Public Methods

    @Override
    public void addRuleInstances(Digester digester) {

        if (create) {
            digester.addObjectCreate(prefix + "Context", "org.apache.catalina.core.StandardContext", "className");
            digester.addSetProperties(prefix + "Context");