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   * The builder class of {@link Unmarshaller} that unmarshals/marshals a value
25   * from/to an {@link Element}.
26   * 
27   * @param <T> the type of unmarshaled and marshaled value.
28   * @author sanjin
29   */
30  public interface UnmarshallerBuilder<T> extends MarshallerBuilder<T> {
31  
32      /**
33       * Create instance of {@link UnmarshallerBuilder} that will build
34       * {@link Unmarshaller}s that will unmarshal/marshal values to specified
35       * {@link Element}.
36       * 
37       * @param element the {@link Element} used for unmarshalling/marshalling.
38       * @return a {@link UnmarshallerBuilder}.
39       */
40      @Override
41      UnmarshallerBuilder<T> withElement(Element element);
42  
43      /**
44       * Create instance of {@link Unmarshaller}.
45       * 
46       * @return a {@link Unmarshaller}.
47       */
48      @Override
49      Unmarshaller<T> build();
50  }