org.opentcs.guing.common.util.PanelRegistry Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of opentcs-plantoverview-common Show documentation

opentcs-plantoverview-common

There is a newer version: 6.2.0

Show newest version

/**
 * Copyright (c) The openTCS Authors.
 *
 * This program is free software and subject to the MIT license. (For details,
 * see the licensing information (LICENSE.txt) you should have received with
 * this copy of the software.)
 */
package org.opentcs.guing.common.util;

import static java.util.Objects.requireNonNull;

import jakarta.inject.Inject;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import org.opentcs.components.plantoverview.PluggablePanelFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * A registry for all plugin panel factories.
 */
public class PanelRegistry {

  /**
   * This class's Logger.
   */
  private static final Logger LOG = LoggerFactory.getLogger(PanelRegistry.class);
  /**
   * The registered factories.
   */
  private final List factories = new ArrayList<>();

  /**
   * Creates a new instance.
   *
   * @param factories The factories.
   */
  @Inject
  public PanelRegistry(Set factories) {
    requireNonNull(factories, "factories");

    // Auto-detect generic client panel factories.
    for (PluggablePanelFactory factory : factories) {
      LOG.info("Setting up plugin panel factory: {}", factory.getClass().getName());
      this.factories.add(factory);
    }
    if (this.factories.isEmpty()) {
      LOG.info("No plugin panel factories found.");
    }
  }

  /**
   * Returns the registered factories.
   *
   * @return The registered factories.
   */
  public List getFactories() {
    return new ArrayList<>(factories);
  }
}