/**
    * This file Copyright (c) 2012-2018 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.jcr.node2bean.impl;
  
  import info.magnolia.jcr.node2bean.TransformationState;
  import info.magnolia.jcr.node2bean.TypeDescriptor;
  import info.magnolia.transformer.TransformationProblem;
  
  import java.util.ArrayDeque;
  import java.util.Collection;
  import java.util.Deque;
  
  import javax.inject.Singleton;
  import javax.jcr.Node;
  import javax.jcr.RepositoryException;
  
  import org.apache.commons.collections4.ArrayStack;
  
  /**
   * Transformation state implementation. Contains stacks of info for the types, beans and the content.
   */
  @Singleton
  public class TransformationStateImpl implements TransformationState {
  
      protected ArrayStack typeStack = new ArrayStack();
  
      protected ArrayStack beanStack = new ArrayStack();
  
      protected ArrayStack nodeStack = new ArrayStack();
  
      private Deque<TransformationProblem> problems = new ArrayDeque<>();
  
      @Override
      public Object getCurrentBean() {
          return beanStack.peek();
      }
  
      @Override
      public void setCurrentBean(Object bean) {
          beanStack.set(beanStack.size() - 1, bean);
      }
  
      @Override
      public TypeDescriptor getCurrentType() {
          return (TypeDescriptor) typeStack.peek();
      }
  
      @Override
      public Node getCurrentNode() {
          return (Node) nodeStack.peek();
      }
  
      @Override
      public Object peekBean(int pos) {
          return beanStack.peek(pos);
      }
  
      @Override
      public TypeDescriptor peekType(int pos) {
          return (TypeDescriptor) typeStack.peek(pos);
      }
  
      @Override
      public Node peekNode(int pos) {
          return (Node) nodeStack.peek(pos);
      }
  
      @Override
     public void popBean() {
         beanStack.pop();
     }
 
     @Override
     public void popType() {
         typeStack.pop();
     }
 
     @Override
     public void popNode() {
         nodeStack.pop();
     }
 
     @Override
     public void pushBean(Object bean) {
         beanStack.push(bean);
     }
 
     @Override
     public void pushProblem(TransformationProblem problem) {
         this.problems.push(problem);
     }
 
     @Override
     public Collection<TransformationProblem> getProblems() {
         return this.problems;
     }
 
     @Override
     public void pushType(TypeDescriptor type) {
         typeStack.push(type);
     }
 
     @Override
     public void pushNode(Node node) {
         nodeStack.push(node);
     }
 
     @Override
     public int getLevel() {
         return Math.max(Math.max(typeStack.size(), beanStack.size()), nodeStack.size());
     }
 
     @Override
     public void trackProblem(TransformationProblem.Builder problemBuilder) {
         problems.add(problemBuilder.withLocation(getCurrentTransformationPath()).build());
     }
 
     /**
      * Returns a currently processed path within the definition, slash (/) for the root element and relative path - otherwise.
      * These paths are primarily interesting for problem aggregation allowing to indicate a more precise place where
      * the configuration transformation failure has happened.
      */
     private String getCurrentTransformationPath() {
         // If no nodes are there in process at the moment, or just one
         // treat it as a root node case
         if (nodeStack.size() <= 1) {
             return "/";
         }
 
         final Node root = (Node) nodeStack.get(0);
 
         try {
             return getCurrentNode().getPath().replace(root.getPath(), "");
         } catch (RepositoryException e) {
             return "<unknown_path>";
         }
     }
 }