*/
package org.opendaylight.yangtools.yang.model.api;
+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 com.google.common.collect.Sets;
import java.net.URI;
import java.util.Collection;
+import java.util.Collections;
import java.util.Optional;
-import java.util.Set;
-import javax.annotation.Nullable;
-import javax.annotation.concurrent.Immutable;
+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;
* Instances MUST be immutable and thus usage in multi threaded
* environment is safe.
*/
-@Immutable
-// FIXME: 3.0.0: ContainerSchemaNode is far too broad. A combination of DataNodeContainer, NotificationNodeContainer
+// FIXME: 6.0.0: ContainerSchemaNode is far too broad. A combination of DataNodeContainer, NotificationNodeContainer
// and possibly DataSchemaNode would reflect SchemaContext traits better.
-public interface SchemaContext extends ContainerSchemaNode {
+// FIXME: 6.0.0: consider deprecating this class in favor of EffectiveModelContext
+public interface SchemaContext extends ContainerSchemaNode, Immutable {
/**
* QName of NETCONF top-level data node.
*/
- QName NAME = QName.create(URI.create("urn:ietf:params:xml:ns:netconf:base:1.0"), "data").intern();
+ // FIXME: YANGTOOLS-1074: we do not want this name
+ @NonNull QName NAME = QName.create(URI.create("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();
+ Collection<? extends DataSchemaNode> getDataDefinitions();
/**
* Returns modules which are part of the schema context. Returned set is required to have its iteration ordered
*
* @return set of the modules which belong to the schema context
*/
- Set<Module> getModules();
+ Collection<? extends 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();
+ Collection<? extends RpcDefinition> getOperations();
/**
* Returns extension definition instances which are defined as the direct
* @return set of <code>ExtensionDefinition</code> instances which
* represents nodes defined via <code>extension</code> YANG keyword
*/
- Set<ExtensionDefinition> getExtensions();
+ Collection<? extends ExtensionDefinition> getExtensions();
/**
* Returns the module matching specified {@link QNameModule}, if present.
* @return Module, if present.
* @throws NullPointerException if qnameModule is null
*/
- Optional<Module> findModule(QNameModule qnameModule);
+ Optional<Module> findModule(@NonNull QNameModule qnameModule);
/**
* Returns module instance (from the context) with specified namespace and no revision.
*
- * @param namespace
- * module namespace
+ * @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 URI namespace) {
+ default Optional<Module> findModule(final @NonNull URI 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
+ * @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 URI namespace, @Nullable final Revision revision) {
+ default Optional<Module> findModule(final @NonNull URI 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
+ * @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 URI namespace, final Optional<Revision> revision) {
+ default Optional<Module> findModule(final @NonNull URI namespace, final @NonNull Optional<Revision> revision) {
return findModule(QNameModule.create(namespace, revision));
}
* @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<Module> findModule(final String name, final Optional<Revision> revision) {
+ default Optional<? extends Module> findModule(final String name, final Optional<Revision> revision) {
return findModules(name).stream().filter(module -> revision.equals(module.getRevision())).findAny();
}
* @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<Module> findModule(final String name, @Nullable final Revision revision) {
+ default Optional<? extends Module> findModule(final String name, final @Nullable Revision revision) {
return findModule(name, Optional.ofNullable(revision));
}
* and no revision.
* @throws NullPointerException if name is null
*/
- default Optional<Module> findModule(final String name) {
+ default Optional<? extends Module> findModule(final String name) {
return findModule(name, Optional.empty());
}
* string with the module name
* @return set of module instances with specified name.
*/
- default Set<Module> findModules(final String name) {
- return Sets.filter(getModules(), m -> name.equals(m.getName()));
+ default Collection<? extends Module> findModules(final String name) {
+ return Collections2.filter(getModules(), m -> name.equals(m.getName()));
}
/**
* @return module instance which has namespace equal to the
* <code>namespace</code> or <code>null</code> in other cases
*/
- default Set<Module> findModules(final URI namespace) {
- return Sets.filter(getModules(), m -> namespace.equals(m.getNamespace()));
+ default Collection<? extends Module> findModules(final URI namespace) {
+ return Collections2.filter(getModules(), m -> namespace.equals(m.getNamespace()));
}
@Override
- default Set<ActionDefinition> getActions() {
+ @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 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
- default Collection<MustDefinition> getMustConstraints() {
+ @Deprecated
+ default Collection<? extends MustDefinition> getMustConstraints() {
return ImmutableSet.of();
}
@Override
+ @Deprecated
default Optional<RevisionAwareXPath> getWhenCondition() {
return Optional.empty();
}
+
+ @Override
+ @Deprecated
+ default boolean isAugmenting() {
+ return false;
+ }
+
+ @Override
+ @Deprecated
+ default boolean isAddedByUses() {
+ return false;
+ }
+
+ @Override
+ @Deprecated
+ default boolean isConfiguration() {
+ return false;
+ }
+
+ @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 boolean isPresenceContainer() {
+ return false;
+ }
+
+ @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 identities derived from a selected 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
+ */
+ @Beta
+ @NonNull Collection<? extends IdentitySchemaNode> getDerivedIdentities(IdentitySchemaNode identity);
}
Code Review / yangtools.git / blobdiff