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.Marshaller;
22  
23  /**
24   * The builder class of {@link Marshaller} that marshals a value to an
25   * {@link Element}.
26   * 
27   * @param <T> the type of marshaled value.
28   * @author sanjin
29   */
30  public interface MarshallerBuilder<T> {
31  
32      /**
33       * Create instance of {@link MarshallerBuilder} that will build
34       * {@link Marshaller}s that will marshal values to specified {@link Element}
35       * .
36       * 
37       * @param element the {@link Element}.
38       * @return a {@link MarshallerBuilder}.
39       */
40      MarshallerBuilder<T> withElement(Element element);
41  
42      /**
43       * Create instance of {@link Marshaller}.
44       * 
45       * @return a {@link Marshaller}.
46       */
47      Marshaller<T> build();
48  }