View Javadoc

1   /**
2    * This file Copyright (c) 2003-2010 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.exchangesimple;
35  
36  import java.io.File;
37  import java.util.Map;
38  import java.util.HashMap;
39  
40  import org.slf4j.Logger;
41  import org.slf4j.LoggerFactory;
42  
43  
44  /**
45   * This class holds all content needed to be activated
46   * @author Sameer Charles $Id: ActivationContent.java 32667 2010-03-13 00:37:06Z gjoseph $
47   */
48  public class ActivationContent implements Cloneable {
49  
50      private static final Logger log = LoggerFactory.getLogger(ActivationContent.class);
51      /**
52       * File list
53       */
54      private Map fileList = new HashMap();
55  
56      /**
57       * properties
58       */
59      private Map properties = new HashMap();
60  
61      /**
62       * add file
63       * @param resourceId
64       * @param file
65       */
66      public void addFile(String resourceId, File file) {
67          this.fileList.put(resourceId, file);
68      }
69  
70      /**
71       * get file
72       * @param resourceId
73       * @return file
74       */
75      public File getFile(String resourceId) {
76          return (File) this.fileList.get(resourceId);
77      }
78  
79      /**
80       * remove file
81       * @param resourceId
82       */
83      public void removeFile(String resourceId) {
84          this.fileList.remove(resourceId);
85      }
86  
87      /**
88       * get all files
89       * @return file list
90       */
91      public Map getFiles() {
92          return this.fileList;
93      }
94  
95      /**
96       * add property
97       * @param key
98       * @param value
99       */
100     public void addProperty(String key, String value) {
101         if (value == null) {
102             value = "";
103         }
104         this.properties.put(key, value);
105     }
106 
107     /**
108      * set property
109      * @param key
110      * @param value
111      */
112     public void setProperty(String key, String value) {
113         if (value == null) {
114             value = "";
115         }
116         // HashMap replaces existing value on put
117         this.properties.put(key, value);
118     }
119 
120     /**
121      * get property
122      * @param key
123      * @return property value
124      */
125     public String getproperty(String key) {
126         return (String) this.properties.get(key);
127     }
128 
129     /**
130      * remove property
131      * @param key
132      */
133     public void removeProperty(String key) {
134         this.properties.remove(key);
135     }
136 
137     /**
138      * get property list
139      * @return all properties
140      */
141     public Map getProperties() {
142         return this.properties;
143     }
144 
145     public Object clone() {
146         try {
147             ActivationContent clone = (ActivationContent) super.clone();
148             // need to clone maps otherwise cloned object would reference the original ones
149             clone.properties = new HashMap(this.properties);
150             clone.fileList = new HashMap(this.fileList);
151             return clone;
152         } catch (CloneNotSupportedException e) {
153             // should never be thrown since we support cloning.
154             log.error("Failed to clone itself with " + e.getLocalizedMessage(), e);
155             return null;
156         }
157     }
158 }