View Javadoc

1   package org.apache.commons.digester3;
2   
3   /*
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *   http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  import org.xml.sax.Attributes;
23  
24  /**
25   * Abstract base class for <code>ObjectCreationFactory</code> implementations.
26   *
27   * @param <T> The object type will be instantiate by this factory.
28   */
29  public abstract class AbstractObjectCreationFactory<T>
30      implements ObjectCreationFactory<T>
31  {
32  
33      // ----------------------------------------------------- Instance Variables
34  
35      /**
36       * The associated <code>Digester</code> instance that was set up by {@link FactoryCreateRule} upon initialization.
37       */
38      private Digester digester = null;
39  
40      // --------------------------------------------------------- Public Methods
41  
42      /**
43       * Factory method called by {@link FactoryCreateRule} to supply an object based on the element's attributes.
44       *
45       * @param attributes the element's attributes
46       * @return creates a new T instance
47       * @throws Exception any exception thrown will be propagated upwards
48       */
49      public abstract T createObject( Attributes attributes )
50          throws Exception;
51  
52      /**
53       * {@inheritDoc}
54       */
55      public Digester getDigester()
56      {
57          return ( this.digester );
58      }
59  
60      /**
61       * {@inheritDoc}
62       */
63      public void setDigester( Digester digester )
64      {
65          this.digester = digester;
66      }
67  
68  }