yang/rfc8528-data-api/src/main/java/org/opendaylight/yangtools/rfc8528/data/api/MountPointNode.java

   1 /*
   2  * Copyright (c) 2019 PANTHEON.tech s.r.o. 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.rfc8528.data.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Collection;
  12 import org.eclipse.jdt.annotation.NonNull;
  13 import org.opendaylight.yangtools.yang.common.QName;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  15 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerChild;
  16 import org.opendaylight.yangtools.yang.data.api.schema.DataContainerNode;
  17 import org.opendaylight.yangtools.yang.data.api.schema.MixinNode;
  18 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  19 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  20 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  21
  22 /**
  23  * Common NormalizedNode representation of a YANG mount point. This interface is not meant to be implemented directly,
  24  * but rather used through its specializations like {@link InlineMountPointNode} and {@link SharedSchemaMountPointNode}.
  25  *
  26  * <p>
  27  * Furthermore, these nodes are not meant to be stored in a {@link DataTree} and most NormalizedNode utilities will be
  28  * confused when they see them. The purpose of this interface is making data interchange between mount point-aware
  29  * components more seamless.
  30  */
  31 @Beta
  32 public interface MountPointNode extends SchemaContextProvider, MixinNode, DataContainerNode<MountPointIdentifier>,
  33         DataContainerChild<MountPointIdentifier, Collection<DataContainerChild<? extends PathArgument, ?>>> {
  34     @Override
  35     default QName getNodeType() {
  36         return getIdentifier().getLabel();
  37     }
  38
  39     @Override
  40     // FIXME: remove this override when SchemaContextProvider's method has sane semantics.
  41     @NonNull SchemaContext getSchemaContext();
  42 }