1 /**
2 * This file Copyright (c) 2012-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.jcr.node2bean;
35
36 import info.magnolia.transformer.TransformationProblem;
37
38 import java.util.Collection;
39
40 import javax.jcr.Node;
41
42 /**
43 * This state contains three stacks. This allows the transformer to know the full state created during the
44 * transformation process. A stack for classes, beans, and nodes are kept.
45 * <p/>
46 * It is the processors job to populate this state.
47 */
48 public interface TransformationState {
49
50 void pushProblem(TransformationProblem problem);
51
52 Collection<TransformationProblem> getProblems();
53
54 void pushType(TypeDescriptor type);
55
56 void popType();
57
58 TypeDescriptor getCurrentType();
59
60 TypeDescriptor peekType(int pos);
61
62 void pushBean(Object bean);
63
64 void popBean();
65
66 Object getCurrentBean();
67
68 void setCurrentBean(Object bean);
69
70 Object peekBean(int pos);
71
72 void pushNode(Node node);
73
74 void popNode();
75
76 Node getCurrentNode();
77
78 Node peekNode(int pos);
79
80 /**
81 * @return the value of the biggest stack size
82 */
83 int getLevel();
84
85 void trackProblem(TransformationProblem.Builder problemBuilder);
86 }