*/
package org.opendaylight.yangtools.yang.model.api;
-import com.google.common.base.Optional;
-import com.google.common.collect.Sets;
-import java.net.URI;
-import java.util.Date;
-import java.util.Set;
-import javax.annotation.concurrent.Immutable;
+import static java.util.Objects.requireNonNull;
+
+import com.google.common.annotations.Beta;
+import com.google.common.collect.Collections2;
+import com.google.common.collect.ImmutableSet;
+import java.util.Collection;
+import java.util.Collections;
+import java.util.Optional;
+import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.Nullable;
+import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.common.QName;
+import org.opendaylight.yangtools.yang.common.QNameModule;
+import org.opendaylight.yangtools.yang.common.Revision;
+import org.opendaylight.yangtools.yang.common.XMLNamespace;
+import org.opendaylight.yangtools.yang.xpath.api.YangXPathExpression.QualifiedBound;
/**
* The interface represents static view of compiled yang files,
* Instances MUST be immutable and thus usage in multi threaded
* environment is safe.
*/
-@Immutable
-public interface SchemaContext extends ContainerSchemaNode {
+// FIXME: 7.0.0: ContainerLike is far too broad. A combination of DataNodeContainer, NotificationNodeContainer
+// and possibly DataSchemaNode would reflect SchemaContext traits better.
+// FIXME: 7.0.0: consider deprecating this class in favor of EffectiveModelContext
+public interface SchemaContext extends ContainerLike, Immutable {
/**
* QName of NETCONF top-level data node.
*/
- QName NAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), null, "data").intern();
+ // FIXME: YANGTOOLS-1074: we do not want this name
+ @NonNull QName NAME = QName.create(XMLNamespace.of("urn:ietf:params:xml:ns:netconf:base:1.0"), "data").intern();
/**
* Returns data schema node instances which represents direct subnodes (like
* @return set of <code>DataSchemaNode</code> instances which represents
* YANG data nodes at the module top level
*/
- Set<DataSchemaNode> getDataDefinitions();
+ @NonNull Collection<? extends @NonNull DataSchemaNode> getDataDefinitions();
/**
- * Returns modules which are part of the schema context.
+ * Returns modules which are part of the schema context. Returned set is required to have its iteration ordered
+ * by module revision, so that if modules are filtered by {@link Module#getName()} or {@link Module#getNamespace()},
+ * modules having the same attribute are encountered newest revision first.
*
* @return set of the modules which belong to the schema context
*/
- Set<Module> getModules();
+ @NonNull Collection<? extends @NonNull Module> getModules();
/**
* Returns rpc definition instances which are defined as the direct
* @return set of <code>RpcDefinition</code> instances which represents
* nodes defined via <code>rpc</code> YANG keyword
*/
- Set<RpcDefinition> getOperations();
+ @NonNull Collection<? extends @NonNull RpcDefinition> getOperations();
/**
- * Returns extencion definition instances which are defined as the direct
+ * Returns extension definition instances which are defined as the direct
* subelements in all YANG modules in the context.
*
* @return set of <code>ExtensionDefinition</code> instances which
* represents nodes defined via <code>extension</code> YANG keyword
*/
- Set<ExtensionDefinition> getExtensions();
+ @NonNull Collection<? extends ExtensionDefinition> getExtensions();
+
+ /**
+ * Returns the module matching specified {@link QNameModule}, if present.
+ *
+ * @param qnameModule requested QNameModule
+ * @return Module, if present.
+ * @throws NullPointerException if qnameModule is null
+ */
+ Optional<Module> findModule(@NonNull QNameModule qnameModule);
+
+ /**
+ * Returns module instance (from the context) with specified namespace and no revision.
+ *
+ * @param namespace module namespace
+ * @return module instance which has name and revision the same as are the values specified in parameters
+ * <code>namespace</code> and no revision.
+ */
+ default Optional<Module> findModule(final @NonNull XMLNamespace namespace) {
+ return findModule(QNameModule.create(namespace));
+ }
+
+ /**
+ * Returns module instance (from the context) with specified namespace and revision.
+ *
+ * @param namespace module namespace
+ * @param revision module revision, may be null
+ * @return module instance which has name and revision the same as are the values specified in parameters
+ * <code>namespace</code> and <code>revision</code>.
+ */
+ default Optional<Module> findModule(final @NonNull XMLNamespace namespace, final @Nullable Revision revision) {
+ return findModule(QNameModule.create(namespace, revision));
+ }
+
+ /**
+ * Returns module instance (from the context) with specified namespace and revision.
+ *
+ * @param namespace module namespace
+ * @param revision module revision, may be null
+ * @return module instance which has name and revision the same as are the values specified in parameters
+ * <code>namespace</code> and <code>revision</code>.
+ */
+ default Optional<Module> findModule(final @NonNull XMLNamespace namespace,
+ final @NonNull Optional<Revision> revision) {
+ return findModule(QNameModule.create(namespace, revision));
+ }
/**
- * Returns module instance (from the context) with concrete name and
- * revision date.
+ * Returns module instance (from the context) with specified name and an optional revision.
*
* @param name
* string with the module name
* @param revision
* date of the module revision
- * @return module instance which has name and revision (if specified) the
- * same as are the values specified in parameters <code>name</code>
- * and <code>revision</code>. In other cases the <code>null</code>
- * value is returned.
+ * @return module instance which has name and revision the same as are the values specified in parameters
+ * <code>name</code> and <code>revision</code>.
+ */
+ default Optional<? extends Module> findModule(final String name, final Optional<Revision> revision) {
+ return findModules(name).stream().filter(module -> revision.equals(module.getRevision())).findAny();
+ }
+
+ /**
+ * Returns module instance (from the context) with specified name and revision.
*
+ * @param name
+ * string with the module name
+ * @param revision
+ * date of the module revision, may be null
+ * @return module instance which has name and revision the same as are the values specified in parameters
+ * <code>name</code> and <code>revision</code>.
*/
- Module findModuleByName(final String name, final Date revision);
+ default Optional<? extends Module> findModule(final String name, final @Nullable Revision revision) {
+ return findModule(name, Optional.ofNullable(revision));
+ }
/**
- * Returns module instance (from the context) with concrete namespace.
+ * Returns module instance (from the context) with specified name and no revision.
*
- * @param namespace
- * URI instance with specified namespace
- * @return module instance which has namespace equal to the
- * <code>namespace</code> or <code>null</code> in other cases
+ * @param name string with the module name
+ * @return module instance which has name and revision the same as are the values specified in <code>name</code>
+ * and no revision.
+ * @throws NullPointerException if name is null
*/
- default Set<Module> findModuleByNamespace(final URI namespace) {
- return Sets.filter(getModules(), m -> namespace.equals(m.getNamespace()));
+ default Optional<? extends Module> findModule(final String name) {
+ return findModule(name, Optional.empty());
}
/**
- * Returns module instance based on given namespace and revision. If
- * revision is not specified, returns module with newest revision.
+ * Returns module instances (from the context) with a concrete name. Returned Set is required to have its iteration
+ * order guarantee that the latest revision is encountered first.
*
- * @param namespace Module namespace, may be null
- * @param revision Module revision, may be null
- * @return Matching module or null if a match is not found
+ * @param name string with the module name
+ * @return set of module instances with specified name.
*/
- default Module findModuleByNamespaceAndRevision(final URI namespace, final Date revision) {
- if (namespace == null) {
- return null;
- }
- for (Module module : findModuleByNamespace(namespace)) {
- if (revision == null || revision.equals(module.getRevision())) {
- return module;
- }
- }
- return null;
+ default @NonNull Collection<? extends @NonNull Module> findModules(final String name) {
+ return Collections2.filter(getModules(), m -> name.equals(m.getName()));
}
/**
- * Get yang source code represented as string for matching
- * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier}.
+ * Returns module instance (from the context) with concrete namespace. Returned Set is required to have its
+ * iteration order guarantee that the latest revision is encountered first.
*
- * @param moduleIdentifier must provide a non-null
- * {@link org.opendaylight.yangtools.yang.model.api.ModuleIdentifier#getName()}, other methods might return
- * null.
- * @return value iif matching module is found in schema context.
+ * @param namespace XMLNamespace instance with specified namespace
+ * @return module instance which has namespace equal to the {@code namespace} or {@code null} in other cases
*/
- Optional<String> getModuleSource(ModuleIdentifier moduleIdentifier);
+ default @NonNull Collection<? extends @NonNull Module> findModules(final XMLNamespace namespace) {
+ return Collections2.filter(getModules(), m -> namespace.equals(m.getNamespace()));
+ }
+
+ @Override
+ @Deprecated
+ default Collection<? extends ActionDefinition> getActions() {
+ return ImmutableSet.of();
+ }
+
+ @Override
+ @Deprecated
+ default Optional<ActionDefinition> findAction(final QName qname) {
+ requireNonNull(qname);
+ return Optional.empty();
+ }
+
+ @Override
+ default Optional<NotificationDefinition> findNotification(final QName qname) {
+ final Optional<Collection<? extends @NonNull NotificationDefinition>> defs = findModule(qname.getModule())
+ .map(Module::getNotifications);
+ if (defs.isPresent()) {
+ for (NotificationDefinition def : defs.get()) {
+ if (qname.equals(def.getQName())) {
+ return Optional.of(def);
+ }
+ }
+ }
+ return Optional.empty();
+ }
+
+ @Override
+ @Deprecated
+ default Optional<String> getDescription() {
+ return Optional.empty();
+ }
+
+ @Override
+ @Deprecated
+ default Optional<String> getReference() {
+ return Optional.empty();
+ }
+
+ @Override
+ @Deprecated
+ default Collection<? extends @NonNull MustDefinition> getMustConstraints() {
+ return ImmutableSet.of();
+ }
+
+ @Override
+ @Deprecated
+ default Optional<? extends QualifiedBound> getWhenCondition() {
+ return Optional.empty();
+ }
+
+ @Override
+ @Deprecated
+ default boolean isAugmenting() {
+ return false;
+ }
+
+ @Override
+ @Deprecated
+ default boolean isAddedByUses() {
+ return false;
+ }
+
+ @Override
+ @Deprecated
+ default Optional<Boolean> effectiveConfig() {
+ return Optional.empty();
+ }
+
+ @Override
+ @Deprecated
+ default QName getQName() {
+ // FIXME: YANGTOOLS-1074: we do not want this name
+ return NAME;
+ }
+
+ @Override
+ @Deprecated
+ default SchemaPath getPath() {
+ return SchemaPath.ROOT;
+ }
+
+ @Override
+ @Deprecated
+ default Status getStatus() {
+ return Status.CURRENT;
+ }
+
+ @Override
+ @Deprecated
+ default Collection<? extends UsesNode> getUses() {
+ return Collections.emptySet();
+ }
+
+ @Override
+ @Deprecated
+ default Collection<? extends AugmentationSchemaNode> getAvailableAugmentations() {
+ return Collections.emptySet();
+ }
+
+ @Beta
+ @Override
+ default Optional<DataSchemaNode> findDataTreeChild(final QName name) {
+ return findModule(name.getModule()).flatMap(mod -> mod.findDataTreeChild(name));
+ }
/**
- * Get all module and submodule identifiers.
+ * Get identities derived from a selected identity.
+ *
+ * @param identity base identity
+ * @return collection of identities derived from this identity
+ * @throws NullPointerException if identity is null
+ * @throws IllegalArgumentException if the specified identity is not present in this context
*/
- Set<ModuleIdentifier> getAllModuleIdentifiers();
+ @Beta
+ @NonNull Collection<? extends IdentitySchemaNode> getDerivedIdentities(IdentitySchemaNode identity);
}
Code Review / yangtools.git / blobdiff