org.apache.commons.digester3.AbstractObjectCreationFactory 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.

There is a newer version: 3.2

Show newest version

package org.apache.commons.digester3;

/*
 * 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.xml.sax.Attributes;

/**
 * Abstract base class for ObjectCreationFactory implementations.
 *
 * @param  The object type will be instantiate by this factory.
 */
public abstract class AbstractObjectCreationFactory
    implements ObjectCreationFactory
{

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

    /**
     * The associated Digester instance that was set up by {@link FactoryCreateRule} upon initialization.
     */
    private Digester digester = null;

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

    /**
     * Factory method called by {@link FactoryCreateRule} to supply an object based on the element's attributes.
     *
     * @param attributes the element's attributes
     * @return creates a new T instance
     * @throws Exception any exception thrown will be propagated upwards
     */
    public abstract T createObject( Attributes attributes )
        throws Exception;

    /**
     * {@inheritDoc}
     */
    public Digester getDigester()
    {
        return ( this.digester );
    }

    /**
     * {@inheritDoc}
     */
    public void setDigester( Digester digester )
    {
        this.digester = digester;
    }

}