git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2023 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   7  * This program and the accompanying materials are made available under the
   8  * terms of the Eclipse Public License 2.0 which is available at
   9  * http://www.eclipse.org/legal/epl-2.0
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.binding.homematic.internal.type;
  14
  15 import java.net.URI;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.HashMap;
  19 import java.util.List;
  20 import java.util.Locale;
  21 import java.util.Map;
  22 import java.util.concurrent.CopyOnWriteArrayList;
  23
  24 import org.eclipse.jdt.annotation.Nullable;
  25 import org.openhab.binding.homematic.type.HomematicThingTypeExcluder;
  26 import org.openhab.core.config.core.ConfigDescription;
  27 import org.openhab.core.config.core.ConfigDescriptionProvider;
  28 import org.osgi.service.component.annotations.Component;
  29 import org.osgi.service.component.annotations.Reference;
  30 import org.osgi.service.component.annotations.ReferenceCardinality;
  31 import org.osgi.service.component.annotations.ReferencePolicy;
  32
  33 /**
  34  *
  35  * @author Gerhard Riegler - Initial contribution
  36  * @author Michael Reitler - Added HomematicThingTypeExcluder
  37  */
  38 @Component(service = { HomematicConfigDescriptionProvider.class, ConfigDescriptionProvider.class })
  39 public class HomematicConfigDescriptionProviderImpl implements HomematicConfigDescriptionProvider {
  40     private Map<URI, ConfigDescription> configDescriptionsByURI = new HashMap<>();
  41     protected List<HomematicThingTypeExcluder> homematicThingTypeExcluders = new CopyOnWriteArrayList<>();
  42
  43     @Reference(cardinality = ReferenceCardinality.MULTIPLE, policy = ReferencePolicy.DYNAMIC)
  44     protected void addHomematicThingTypeExcluder(HomematicThingTypeExcluder homematicThingTypeExcluder) {
  45         if (homematicThingTypeExcluders != null) {
  46             homematicThingTypeExcluders.add(homematicThingTypeExcluder);
  47         }
  48     }
  49
  50     protected void removeHomematicThingTypeExcluder(HomematicThingTypeExcluder homematicThingTypeExcluder) {
  51         if (homematicThingTypeExcluders != null) {
  52             homematicThingTypeExcluders.remove(homematicThingTypeExcluder);
  53         }
  54     }
  55
  56     private boolean isConfigDescriptionExcluded(URI configDescriptionURI) {
  57         // delegate to excluders
  58         for (HomematicThingTypeExcluder excluder : homematicThingTypeExcluders) {
  59             if (excluder.isConfigDescriptionExcluded(configDescriptionURI)) {
  60                 return true;
  61             }
  62         }
  63         return false;
  64     }
  65
  66     @Override
  67     public Collection<ConfigDescription> getConfigDescriptions(Locale locale) {
  68         Collection<ConfigDescription> result = new ArrayList<>();
  69         for (URI configDescriptionURI : configDescriptionsByURI.keySet()) {
  70             if (!isConfigDescriptionExcluded(configDescriptionURI)) {
  71                 result.add(configDescriptionsByURI.get(configDescriptionURI));
  72             }
  73         }
  74         return result;
  75     }
  76
  77     @Override
  78     public ConfigDescription getConfigDescription(URI uri, @Nullable Locale locale) {
  79         return isConfigDescriptionExcluded(uri) ? null : configDescriptionsByURI.get(uri);
  80     }
  81
  82     @Override
  83     public ConfigDescription getInternalConfigDescription(URI uri) {
  84         return configDescriptionsByURI.get(uri);
  85     }
  86
  87     @Override
  88     public void addConfigDescription(ConfigDescription configDescription) {
  89         configDescriptionsByURI.put(configDescription.getUID(), configDescription);
  90     }
  91 }