2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.model.api;
10 import com.google.common.base.Optional;
11 import com.google.common.collect.Sets;
13 import java.util.Date;
15 import javax.annotation.concurrent.Immutable;
16 import org.opendaylight.yangtools.yang.common.QName;
19 * The interface represents static view of compiled yang files,
20 * contains the methods for obtaining all the top level context
21 * data (data from all modules) like YANG notifications, extensions,
23 * Instances MUST be immutable and thus usage in multi threaded
24 * environment is safe.
27 public interface SchemaContext extends ContainerSchemaNode {
29 * QName of NETCONF top-level data node.
31 QName NAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "data").intern();
34 * Returns data schema node instances which represents direct subnodes (like
35 * leaf, leaf-list, list, container) in all YANG modules in the context.
37 * @return set of <code>DataSchemaNode</code> instances which represents
38 * YANG data nodes at the module top level
40 Set<DataSchemaNode> getDataDefinitions();
43 * Returns modules which are part of the schema context.
45 * @return set of the modules which belong to the schema context
47 Set<Module> getModules();
50 * Returns rpc definition instances which are defined as the direct
51 * subelements in all YANG modules in the context.
53 * @return set of <code>RpcDefinition</code> instances which represents
54 * nodes defined via <code>rpc</code> YANG keyword
56 Set<RpcDefinition> getOperations();
59 * Returns extencion definition instances which are defined as the direct
60 * subelements in all YANG modules in the context.
62 * @return set of <code>ExtensionDefinition</code> instances which
63 * represents nodes defined via <code>extension</code> YANG keyword
65 Set<ExtensionDefinition> getExtensions();
68 * Returns module instance (from the context) with concrete name and
72 * string with the module name
74 * date of the module revision
75 * @return module instance which has name and revision (if specified) the
76 * same as are the values specified in parameters <code>name</code>
77 * and <code>revision</code>. In other cases the <code>null</code>
81 Module findModuleByName(String name, Date revision);
83 default Optional<Module> findAnyModuleByName(final String name) {
84 return Optional.fromNullable(findModuleByName(name, null));
88 * Returns module instance (from the context) with concrete namespace.
91 * URI instance with specified namespace
92 * @return module instance which has namespace equal to the
93 * <code>namespace</code> or <code>null</code> in other cases
95 default Set<Module> findModuleByNamespace(final URI namespace) {
96 return Sets.filter(getModules(), m -> namespace.equals(m.getNamespace()));
100 * Returns module instance based on given namespace and revision. If
101 * revision is not specified, returns module with newest revision.
103 * @param namespace Module namespace, may be null
104 * @param revision Module revision, may be null
105 * @return Matching module or null if a match is not found
107 default Module findModuleByNamespaceAndRevision(final URI namespace, final Date revision) {
108 if (namespace == null) {
111 for (Module module : findModuleByNamespace(namespace)) {
112 if (revision == null || revision.equals(module.getRevision())) {
120 * Get yang source code represented as string for matching
121 * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier}.
123 * @param moduleIdentifier must provide a non-null
124 * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier#getName()}, other methods might return
126 * @return value iif matching module is found in schema context.
128 Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier);
131 * Get all module and submodule identifiers.
133 Set<ModuleIdentifier> getAllModuleIdentifiers();