1 /**
2 * This file Copyright (c) 2016 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.transformer;
35
36 import java.util.Collection;
37
38 /**
39 * This is used to track and aggregate errors during the process of conversion.
40 * @param <T> bean object, conversion result
41 */
42 public interface TransformationResult<T> {
43
44 static <T> TransformationResult<T> transformationResult(T bean, Collection<TransformationProblem> problems) {
45 return new TransformationResultImpl<>(bean, problems);
46 }
47
48 T get();
49
50 /**
51 * Mis-configured properties, failed conversion of sub-parts etc.
52 */
53 Collection<TransformationProblem> getProblems();
54
55 /**
56 * Default impl class.
57 * @param <T>
58 */
59 class TransformationResultImpl<T> implements TransformationResult<T> {
60 private final T bean;
61 private final Collection<TransformationProblem> problems;
62
63 public TransformationResultImpl(T bean, Collection<TransformationProblem> problems) {
64 this.bean = bean;
65 this.problems = problems;
66 }
67
68 @Override
69 public T get() {
70 return bean;
71 }
72
73 @Override
74 public Collection<TransformationProblem> getProblems() {
75 return problems;
76 }
77 }
78 }