/**
    * This file Copyright (c) 2016-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.ui.framework.tools;
  
  import info.magnolia.objectfactory.ComponentProvider;
  import info.magnolia.ui.api.app.SubAppContext;
  import info.magnolia.ui.api.app.SubAppDescriptor;
  import info.magnolia.ui.framework.app.BaseSubApp;
  
  import java.util.Map;
  
  import javax.inject.Inject;
  
  import org.apache.commons.collections4.MapUtils;
  
  /**
   * Implementation of a subApp with several tools.
   *
   * @see ToolsSubAppView
   * @see ToolsSubAppDescriptor
   * @see info.magnolia.ui.api.app.SubApp
   *
   * @deprecated since 6.2 - without direct replacement.
   *
   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
   */
  @Deprecated
  public class ToolsSubApp extends BaseSubApp<ToolsSubAppView> {
  
      private final SubAppContext subAppContext;
      private final ToolsSubAppView subAppView;
      private final ComponentProvider componentProvider;
  
      @Inject
      public ToolsSubApp(SubAppContext subAppContext, ToolsSubAppView subAppView, ComponentProvider componentProvider) {
          super(subAppContext, subAppView);
  
          this.subAppContext = subAppContext;
          this.subAppView = subAppView;
          this.componentProvider = componentProvider;
      }
  
      @Override
      protected void onSubAppStart() {
          SubAppDescriptor subAppDescriptor = subAppContext.getSubAppDescriptor();
  
          if (!(subAppDescriptor instanceof ToolsSubAppDescriptor)) {
              throw new IllegalArgumentException(String.format("Cannot start ToolsSubApp '%s', expected ToolsSubAppDescriptor but got %s.", subAppDescriptor.getName(), subAppDescriptor.getClass().getSimpleName()));
          }
  
          ToolsSubAppDescriptori/framework/tools/ToolsSubAppDescriptor.html#ToolsSubAppDescriptor">ToolsSubAppDescriptor toolsSubAppDescriptor = (ToolsSubAppDescriptor) subAppDescriptor;
  
          subAppView.setDescription(toolsSubAppDescriptor.getDescription());
  
          Map<String, ToolDefinition> toolDefinitions = toolsSubAppDescriptor.getTools();
          if (MapUtils.isEmpty(toolDefinitions) || toolDefinitions.containsKey(null)) {
              throw new IllegalArgumentException(String.format("Cannot start ToolsSubApp '%s', 'tools' (ToolDefinitions) are not configured.", subAppDescriptor.getName()));
          }
  
          for (ToolDefinition toolDefinition : toolDefinitions.values()) {
              if (toolDefinition.getPresenterClass() == null) {
                  throw new IllegalArgumentException(String.format("Cannot start ToolPresenter '%s', 'presenterClass' is not configured.", toolDefinition.getName()));
              }
  
              ToolPresenter toolPresenter = componentProvider.newInstance(toolDefinition.getPresenterClass());
              subAppView.addToolView(toolDefinition.getLabel(), toolPresenter.start(toolDefinition));
          }
      }
 }