/*
- * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
+ *
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v1.0 which accompanies this distribution,
* and is available at http://www.eclipse.org/legal/epl-v10.html
*/
package org.opendaylight.yangtools.yang.parser.util;
-import static java.util.Arrays.asList;
-
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
-import com.google.common.base.Optional;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import com.google.common.collect.Sets;
-
import java.net.URI;
-import java.util.ArrayList;
+import java.util.Arrays;
import java.util.Collection;
-import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
+import java.util.Objects;
import java.util.Set;
-
import org.opendaylight.yangtools.yang.common.SimpleDateFormatUtil;
import org.opendaylight.yangtools.yang.model.api.Module;
import org.opendaylight.yangtools.yang.model.api.ModuleImport;
-import org.opendaylight.yangtools.yang.model.api.SchemaContext;
-import org.opendaylight.yangtools.yang.parser.builder.impl.ModuleBuilder;
import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.Node;
import org.opendaylight.yangtools.yang.parser.util.TopologicalSort.NodeImpl;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
- * Creates a module dependency graph from provided {@link ModuleBuilder}s and
- * provides a {@link #sort(ModuleBuilder...)} method. It is topological sort and
+ * Creates a module dependency graph from provided {@link Module}s and
+ * provides a {@link #sort(Module...)} method. It is topological sort and
* returns modules in order in which they should be processed (e.g. if A imports
* B, sort returns {B, A}).
*/
public final class ModuleDependencySort {
- private static final Date DEFAULT_REVISION = new Date(0);
+ private static final Date DEFAULT_REVISION = SimpleDateFormatUtil.DEFAULT_DATE_REV;
private static final Logger LOGGER = LoggerFactory.getLogger(ModuleDependencySort.class);
- private static final Function<Node, Module> TOPOLOGY_FUNCTION = new Function<TopologicalSort.Node, Module>() {
- @Override
- public Module apply(final TopologicalSort.Node input) {
- ModuleOrModuleBuilder moduleOrModuleBuilder = ((ModuleNodeImpl) input).getReference();
- return moduleOrModuleBuilder.getModule();
+ private static final Function<Node, Module> TOPOLOGY_FUNCTION = input -> {
+ if (input == null) {
+ return null;
}
+ return ((ModuleNodeImpl) input).getReference();
};
/**
private ModuleDependencySort() {
}
-
- /**
- * Extracts {@link ModuleBuilder} from a {@link ModuleNodeImpl}.
- */
- private static final Function<TopologicalSort.Node, ModuleBuilder> NODE_TO_MODULEBUILDER = new Function<TopologicalSort.Node, ModuleBuilder>() {
- @Override
- public ModuleBuilder apply(final TopologicalSort.Node input) {
- // Cast to ModuleBuilder from Node and return
- ModuleOrModuleBuilder moduleOrModuleBuilder = ((ModuleNodeImpl) input).getReference();
- return moduleOrModuleBuilder.getModuleBuilder();
- }
- };
-
/**
- * Topological sort of module builder dependency graph.
+ * Topological sort of module dependency graph.
*
- * @return Sorted list of Module builders. Modules can be further processed
- * in returned order.
+ * @param modules YANG modules
+ * @return Sorted list of Modules. Modules can be further processed in
+ * returned order.
*/
- public static List<ModuleBuilder> sort(final ModuleBuilder... builders) {
- return sort(asList(builders));
- }
-
- public static List<ModuleBuilder> sort(final Collection<ModuleBuilder> builders) {
- List<TopologicalSort.Node> sorted = sortInternal(ModuleOrModuleBuilder.fromAll(
- Collections.<Module>emptySet(),builders));
- return Lists.transform(sorted, NODE_TO_MODULEBUILDER);
- }
-
- public static List<ModuleBuilder> sortWithContext(final SchemaContext context, final ModuleBuilder... builders) {
- List<ModuleOrModuleBuilder> all = ModuleOrModuleBuilder.fromAll(context.getModules(), asList(builders));
-
- List<TopologicalSort.Node> sorted = sortInternal(all);
- // Cast to ModuleBuilder from Node if possible and return
- return Lists.transform(sorted, new Function<TopologicalSort.Node, ModuleBuilder>() {
-
- @Override
- public ModuleBuilder apply(final TopologicalSort.Node input) {
- ModuleOrModuleBuilder moduleOrModuleBuilder = ((ModuleNodeImpl) input).getReference();
- if (moduleOrModuleBuilder.isModuleBuilder()) {
- return moduleOrModuleBuilder.getModuleBuilder();
- } else {
- return null;
- }
- }
- });
+ public static List<Module> sort(final Module... modules) {
+ return sort(Arrays.asList(modules));
}
/**
* Topological sort of module dependency graph.
*
+ * @param modules YANG modules
* @return Sorted list of Modules. Modules can be further processed in
* returned order.
*/
- public static List<Module> sort(final Module... modules) {
- List<TopologicalSort.Node> sorted = sortInternal(ModuleOrModuleBuilder.fromAll(asList(modules),
- Collections.<ModuleBuilder>emptyList()));
+ public static List<Module> sort(final Iterable<Module> modules) {
+ final List<TopologicalSort.Node> sorted = sortInternal(modules);
// Cast to Module from Node and return
return Lists.transform(sorted, TOPOLOGY_FUNCTION);
}
- private static List<TopologicalSort.Node> sortInternal(final Iterable<ModuleOrModuleBuilder> modules) {
+ private static List<TopologicalSort.Node> sortInternal(final Iterable<Module> modules) {
Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = createModuleGraph(modules);
Set<TopologicalSort.Node> nodes = Sets.newHashSet();
}
@VisibleForTesting
- static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(final Iterable<ModuleOrModuleBuilder> builders) {
+ static Map<String, Map<Date, ModuleNodeImpl>> createModuleGraph(final Iterable<Module> builders) {
Map<String, Map<Date, ModuleNodeImpl>> moduleGraph = Maps.newHashMap();
processModules(moduleGraph, builders);
* Extract module:revision from module builders
*/
private static void processDependencies(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
- final Iterable<ModuleOrModuleBuilder> mmbs) {
- Map<URI, Object> allNS = new HashMap<>();
+ final Iterable<Module> mmbs) {
+ Map<URI, Module> allNS = new HashMap<>();
// Create edges in graph
- for (ModuleOrModuleBuilder mmb : mmbs) {
+ for (Module module : mmbs) {
Map<String, Date> imported = Maps.newHashMap();
String fromName;
Collection<ModuleImport> imports;
URI ns;
- if (mmb.isModule()) {
- Module module = mmb.getModule();
- fromName = module.getName();
- fromRevision = module.getRevision();
- imports = module.getImports();
- ns = module.getNamespace();
- } else {
- ModuleBuilder moduleBuilder = mmb.getModuleBuilder();
- fromName = moduleBuilder.getName();
- fromRevision = moduleBuilder.getRevision();
- imports = moduleBuilder.getImports().values();
- ns = moduleBuilder.getNamespace();
- }
+ fromName = module.getName();
+ fromRevision = module.getRevision();
+ imports = module.getImports();
+ ns = module.getNamespace();
// check for existence of module with same namespace
if (allNS.containsKey(ns)) {
- Object mod = allNS.get(ns);
- String name = null;
- Date revision = null;
- if (mod instanceof Module) {
- name = ((Module) mod).getName();
- revision = ((Module) mod).getRevision();
- } else if (mod instanceof ModuleBuilder) {
- name = ((ModuleBuilder) mod).getName();
- revision = ((ModuleBuilder) mod).getRevision();
- }
- if (!(fromName.equals(name))) {
+ final Module mod = allNS.get(ns);
+ final String name = mod.getName();
+ final Date revision = mod.getRevision();
+ if (!fromName.equals(name)) {
LOGGER.warn(
"Error while sorting module [{}, {}]: module with same namespace ({}) already loaded: [{}, {}]",
fromName, fromRevision, ns, name, revision);
}
} else {
- allNS.put(ns, mmb);
+ allNS.put(ns, module);
}
// no need to check if other Type of object, check is performed in
* graph
*/
private static void processModules(final Map<String, Map<Date, ModuleNodeImpl>> moduleGraph,
- final Iterable<ModuleOrModuleBuilder> builders) {
+ final Iterable<Module> modules) {
// Process nodes
- for (ModuleOrModuleBuilder momb : builders) {
-
- String name;
- Date rev;
-
- if (momb.isModule()) {
- name = momb.getModule().getName();
- rev = momb.getModule().getRevision();
- } else {
- name = momb.getModuleBuilder().getName();
- rev = momb.getModuleBuilder().getRevision();
- }
+ for (Module momb : modules) {
+ String name = momb.getName();
+ Date rev = momb.getRevision();
if (rev == null) {
rev = DEFAULT_REVISION;
}
if (moduleGraph.get(name) == null) {
- moduleGraph.put(name, Maps.<Date, ModuleNodeImpl> newHashMap());
+ moduleGraph.put(name, Maps.newHashMap());
}
if (moduleGraph.get(name).get(rev) != null) {
static class ModuleNodeImpl extends NodeImpl {
private final String name;
private final Date revision;
- private final ModuleOrModuleBuilder originalObject;
+ private final Module originalObject;
- public ModuleNodeImpl(final String name, final Date revision, final ModuleOrModuleBuilder builder) {
+ public ModuleNodeImpl(final String name, final Date revision, final Module module) {
this.name = name;
this.revision = revision;
- this.originalObject = builder;
+ this.originalObject = module;
}
public String getName() {
public int hashCode() {
final int prime = 31;
int result = 1;
- result = prime * result + ((name == null) ? 0 : name.hashCode());
- result = prime * result + ((revision == null) ? 0 : revision.hashCode());
+ result = prime * result + Objects.hashCode(name);
+ result = prime * result + Objects.hashCode(revision);
return result;
}
return "Module [name=" + name + ", revision=" + formatRevDate(revision) + "]";
}
- public ModuleOrModuleBuilder getReference() {
+ public Module getReference() {
return originalObject;
}
}
}
-class ModuleOrModuleBuilder {
- private final Optional<Module> maybeModule;
- private final Optional<ModuleBuilder> maybeModuleBuilder;
-
- ModuleOrModuleBuilder(final Module module) {
- maybeModule = Optional.of(module);
- maybeModuleBuilder = Optional.absent();
- }
-
- ModuleOrModuleBuilder(final ModuleBuilder moduleBuilder) {
- maybeModule = Optional.absent();
- maybeModuleBuilder = Optional.of(moduleBuilder);
- }
- boolean isModule(){
- return maybeModule.isPresent();
- }
- boolean isModuleBuilder(){
- return maybeModuleBuilder.isPresent();
- }
- Module getModule(){
- return maybeModule.get();
- }
- ModuleBuilder getModuleBuilder(){
- return maybeModuleBuilder.get();
- }
-
- static List<ModuleOrModuleBuilder> fromAll(final Collection<Module> modules, final Collection<ModuleBuilder> moduleBuilders) {
- List<ModuleOrModuleBuilder> result = new ArrayList<>(modules.size() + moduleBuilders.size());
- for(Module m: modules){
- result.add(new ModuleOrModuleBuilder(m));
- }
- for (ModuleBuilder mb : moduleBuilders) {
- result.add(new ModuleOrModuleBuilder(mb));
- }
- return result;
- }
-}
Code Review / yangtools.git / blobdiff