View Javadoc

1   /* This file is part of COPAL (COntext Provisioning for All).
2    *
3    * COPAL is a part of SM4All (Smart hoMes for All) project.
4    *
5    * COPAL is free software: you can redistribute it and/or modify
6    * it under the terms of the GNU Lesser General Public License as published by
7    * the Free Software Foundation, either version 3 of the License, or
8    * (at your option) any later version.
9    *
10   * COPAL is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13   * GNU Lesser General Public License for more details.
14   *
15   * You should have received a copy of the GNU Lesser General Public License
16   * along with COPAL. If not, see <http://www.gnu.org/licenses/>.
17   */
18  package at.ac.tuwien.infosys.sm4all.copal.api.xml;
19  
20  import org.w3c.dom.Element;
21  import at.ac.tuwien.infosys.sm4all.copal.api.util.Unmarshaller;
22  
23  /**
24   * Base abstract class for implementations of {@link UnmarshallerBuilder} to
25   * use.
26   * 
27   * @param <T> the type of {@link Unmarshaller} built.
28   * @author sanjin
29   */
30  public abstract class BaseUnmarshallerBuilder<T> extends
31          BaseMarshallerBuilder<T> implements UnmarshallerBuilder<T> {
32  
33      /**
34       * Create uninitialized instance of {@link BaseUnmarshallerBuilder}.
35       */
36      protected BaseUnmarshallerBuilder() {
37          super();
38      }
39  
40      /**
41       * Clone-constructor.
42       * 
43       * @param builder the cloned {@link BaseUnmarshallerBuilder}.
44       */
45      protected BaseUnmarshallerBuilder(final BaseUnmarshallerBuilder<T> builder) {
46          super(builder);
47      }
48  
49      /**
50       * Create instance of {@link BaseUnmarshallerBuilder} by copying this
51       * {@link BaseUnmarshallerBuilder}.
52       * 
53       * @return an {@link BaseUnmarshallerBuilder}.
54       */
55      @Override
56      protected abstract BaseUnmarshallerBuilder<T> copy();
57  
58      /**
59       * Create instance of {@link BaseUnmarshallerBuilder} that will build
60       * {@link Unmarshaller}s that will marshal values to specified
61       * {@link Element}.
62       * 
63       * @param element the {@link Element}.
64       * @return an {@link BaseUnmarshallerBuilder}.
65       */
66      @Override
67      public BaseUnmarshallerBuilder<T> withElement(final Element element) {
68          return (BaseUnmarshallerBuilder<T>) super.withElement(element);
69      }
70  }