View Javadoc

1   /**
2    * This file Copyright (c) 2008-2011 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.samples;
35  
36  import java.util.HashMap;
37  import java.util.Map;
38  
39  import org.slf4j.Logger;
40  import org.slf4j.LoggerFactory;
41  
42  
43  /**
44   * This is a dummy class loaded from the module configuration, it defines 2 properties:<br/>
45   * (modules/samples/config/sampleList/sampleClass/)<br/>
46   * <code>name</code> will be taken from the name of the node<br/>
47   * <code>active</code> can be set by user is a boolean defined as boolean in the configuration.<br/>
48   * The parameter map gets loaded from the values set in the configuration (modules/samples/config/sampleList/sampleClass/parameters)
49   * @author tmiyar
50   *
51   */
52  public class Dummy {
53  
54      final private static Logger log = LoggerFactory.getLogger(Dummy.class);
55  
56      private String name;
57  
58      private boolean active;
59  
60      private Map parameters = new HashMap();
61  
62      public String getName() {
63          log.info("No need to define name node data, will take the name of the node for this property: " + name);
64          return name;
65      }
66  
67      public void setName(String name) {
68          this.name = name;
69      }
70  
71      public boolean isActive() {
72          log.info("Need to define active node data: " + active);
73          return active;
74      }
75  
76      public void setActive(boolean active) {
77          this.active = active;
78      }
79  
80      public Map getParameters() {
81          log.info("Need to define parameters node data: " + parameters);
82          return parameters;
83      }
84  
85      public void setParameters(Map parameters) {
86          this.parameters = parameters;
87      }
88  
89  
90  
91  }