001package org.apache.commons.digester3;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.xml.sax.Attributes;
023
024/**
025 * Abstract base class for <code>ObjectCreationFactory</code> implementations.
026 *
027 * @param <T> The object type will be instantiate by this factory.
028 */
029public abstract class AbstractObjectCreationFactory<T>
030    implements ObjectCreationFactory<T>
031{
032
033    // ----------------------------------------------------- Instance Variables
034
035    /**
036     * The associated <code>Digester</code> instance that was set up by {@link FactoryCreateRule} upon initialization.
037     */
038    private Digester digester = null;
039
040    // --------------------------------------------------------- Public Methods
041
042    /**
043     * Factory method called by {@link FactoryCreateRule} to supply an object based on the element's attributes.
044     *
045     * @param attributes the element's attributes
046     * @return creates a new T instance
047     * @throws Exception any exception thrown will be propagated upwards
048     */
049    public abstract T createObject( Attributes attributes )
050        throws Exception;
051
052    /**
053     * {@inheritDoc}
054     */
055    public Digester getDigester()
056    {
057        return ( this.digester );
058    }
059
060    /**
061     * {@inheritDoc}
062     */
063    public void setDigester( Digester digester )
064    {
065        this.digester = digester;
066    }
067
068}