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.listener.xml;
19  
20  import org.w3c.dom.Element;
21  import at.ac.tuwien.infosys.sm4all.copal.api.listener.ContextListener;
22  import at.ac.tuwien.infosys.sm4all.copal.api.xml.ArrayMarshaller;
23  import at.ac.tuwien.infosys.sm4all.copal.api.xml.Constants;
24  
25  /**
26   * Command that marshalls an array of {@link ContextListener}s into an
27   * {@link Element}.
28   * 
29   * @author sanjin
30   */
31  public class XMLContextListeners extends ArrayMarshaller<ContextListener> {
32  
33      /**
34       * Creates instance of {@link ContextListener}s marshaller which uses
35       * specified {@link Element} to marshal the {@link ContextListener}s.
36       * 
37       * @param element the {@link Element} used for marshalling and
38       *        unmarshalling.
39       * @throws NullPointerException if specified {@link Element} is
40       *         <code>null</code>.
41       */
42      public XMLContextListeners(final Element element) {
43          super(element, Constants.COPAL_NAMESPACE_URI, Constants.COPAL_PREFIX,
44                  "Listener");
45      }
46  
47      /**
48       * Marshals specified {@link ContextListener} into specified {@link Element}
49       * using the {@link XMLContextListener#marshal(ContextListener)} method.
50       * 
51       * @param listener the {@link ContextListener} to marshal.
52       * @param element the {@link Element} into which specified
53       *        {@link ContextListener} should be marshalled.
54       */
55      @Override
56      protected void marshal(final ContextListener listener, final Element element) {
57          new XMLContextListener(element).marshal(listener);
58      }
59  }