yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/repo/SemVerDependencyResolver.java

   1 /*
   2  * Copyright (c) 2016 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.repo;
   9
  10 import java.util.Collection;
  11 import java.util.Map;
  12 import java.util.Optional;
  13 import org.opendaylight.yangtools.concepts.SemVer;
  14 import org.opendaylight.yangtools.yang.model.api.ModuleImport;
  15 import org.opendaylight.yangtools.yang.model.repo.api.SemVerSourceIdentifier;
  16 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  17 import org.opendaylight.yangtools.yang.parser.rfc7950.repo.YangModelDependencyInfo;
  18
  19 final class SemVerDependencyResolver extends DependencyResolver {
  20
  21     protected SemVerDependencyResolver(final Map<SourceIdentifier, YangModelDependencyInfo> depInfo) {
  22         super(depInfo);
  23     }
  24
  25     protected static SourceIdentifier findCompatibleVersion(final Iterable<SourceIdentifier> haystack,
  26             final ModuleImport mi) {
  27         final String requestedModuleName = mi.getModuleName();
  28         for (SourceIdentifier r : haystack) {
  29             if (requestedModuleName.equals(r.getName())
  30                     && isCompatible(((SemVerSourceIdentifier) r).getSemanticVersion(), mi.getSemanticVersion())) {
  31                 return r;
  32             }
  33         }
  34
  35         return null;
  36     }
  37
  38     private static boolean isCompatible(final Optional<SemVer> moduleSemVer, final Optional<SemVer> importSemVer) {
  39         if (importSemVer.isEmpty()) {
  40             // Import does not care about the version
  41             return true;
  42         }
  43         if (moduleSemVer.isEmpty()) {
  44             // Modules which do not declare a semantic version are incompatible with imports which do
  45             return false;
  46         }
  47
  48         final SemVer modVer = moduleSemVer.get();
  49         final SemVer impVer = importSemVer.get();
  50         return modVer.getMajor() == impVer.getMajor() && modVer.compareTo(impVer) >= 0;
  51     }
  52
  53     @Override
  54     protected boolean isKnown(final Collection<SourceIdentifier> haystack, final ModuleImport mi) {
  55         final SemVerSourceIdentifier msi = SemVerSourceIdentifier.create(mi.getModuleName(), mi.getRevision(),
  56             mi.getSemanticVersion().orElse(null));
  57
  58         // Quick lookup
  59         if (haystack.contains(msi)) {
  60             return true;
  61         }
  62
  63         // Slow revision-less walk
  64         return findCompatibleVersion(haystack, mi) != null;
  65     }
  66
  67     public static SemVerDependencyResolver create(final Map<SourceIdentifier, YangModelDependencyInfo> depInfo) {
  68         return new SemVerDependencyResolver(depInfo);
  69     }
  70 }