View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 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.model.reader;
35  
36  import java.util.HashSet;
37  import java.util.Set;
38  
39  import org.apache.commons.beanutils.ConvertUtils;
40  import org.apache.commons.beanutils.Converter;
41  import org.apache.commons.betwixt.strategy.TypeBindingStrategy;
42  
43  /**
44   * A TypeBindingStrategy for Betwixt where we can register our own {@link Converter}s. When such a Converter
45   * is registered, betwixt will attempt to convert the xml element's value from String to object.
46   * <strong>Beware</strong>, these converters are registered globally, thanks to the singleton-esque nature
47   * of BeanUtils. If a cleaner solution is found, it will be much welcome.
48   */
49  class BetwixtBindingStrategy extends TypeBindingStrategy {
50      private final TypeBindingStrategy delegate = new TypeBindingStrategy.Default();
51      private final Set<Class<?>> convertedClasses;
52  
53      BetwixtBindingStrategy() {
54          this.convertedClasses = new HashSet<Class<?>>();
55      }
56  
57      void registerConverter(Class<?> clazz, Converter converter) {
58          convertedClasses.add(clazz);
59          // yuck, configuring the beanutils singleton - should be OK though, it's unlikely a 3rd party would use our model classes.
60          ConvertUtils.register(converter, clazz);
61      }
62  
63      @Override
64      public TypeBindingStrategy.BindingType bindingType(Class type) {
65          if (convertedClasses.contains(type)) {
66              return TypeBindingStrategy.BindingType.PRIMITIVE;
67          }
68          return delegate.bindingType(type);
69      }
70  }