View Javadoc
1   /**
2    * This file Copyright (c) 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.ui.form.field.converter;
35  
36  import java.util.Locale;
37  
38  /**
39   * Converts field values between a model and a presentation type.
40   *
41   * @param <Model> the model type
42   * @param <Presentation> the presentation type
43   */
44  public interface FieldValueConverter<Presentation, Model> {
45  
46      Model convertToModel(Presentation value, Class<? extends Model> targetType, Locale locale);
47  
48      Presentation convertToPresentation(Model value, Class<? extends Presentation> targetType, Locale locale);
49  
50      /**
51       * Wrapper that delegates conversion to given{@link #delegate}.
52       *
53       * @param <Presentation> the model type
54       * @param <Model> the presentation type
55       */
56      class Wrapper<Presentation, Model> implements FieldValueConverter<Presentation, Model> {
57  
58          private final FieldValueConverter<Presentation, Model> delegate;
59  
60          public Wrapper(FieldValueConverter<Presentation, Model> delegate) {
61              this.delegate = delegate;
62          }
63  
64          @Override
65          public Model convertToModel(Presentation value, Class<? extends Model> targetType, Locale locale) {
66              return delegate.convertToModel(value, targetType, locale);
67          }
68  
69          @Override
70          public Presentation convertToPresentation(Model value, Class<? extends Presentation> targetType, Locale locale) {
71              return this.delegate.convertToPresentation(value, targetType, locale);
72          }
73      }
74  }