org.apache.commons.digester3.xmlrules.AbstractXmlRule Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-digester3 Show documentation

The Apache Commons Digester package lets you configure an XML to Java object mapping module which triggers certain actions called rules whenever a particular pattern of nested XML elements is recognized.

The newest version!

package org.apache.commons.digester3.xmlrules;

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import org.apache.commons.digester3.binder.LinkedRuleBuilder;
import org.apache.commons.digester3.binder.RulesBinder;
import org.xml.sax.Attributes;

/**
 * 
 */
abstract class AbstractXmlRule
    extends PatternRule
{

    private final RulesBinder targetRulesBinder;

    public AbstractXmlRule( RulesBinder targetRulesBinder, PatternStack patternStack )
    {
        super( "pattern", patternStack );
        this.targetRulesBinder = targetRulesBinder;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void begin( String namespace, String name, Attributes attributes )
        throws Exception
    {
        super.begin( namespace, name, attributes );
        this.bindRule( this.targetRulesBinder.forPattern( this.getMatchingPattern() ), attributes );
    }

    /**
     * @param linkedRuleBuilder
     * @param attributes
     */
    protected abstract void bindRule( LinkedRuleBuilder linkedRuleBuilder, Attributes attributes )
        throws Exception;

}