yanglib/mdsal-yanglib-api/src/main/java/org/opendaylight/mdsal/yanglib/api/YangLibSupport.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.mdsal.yanglib.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.opendaylight.yangtools.yang.common.MountPointLabel;
  13 import org.opendaylight.yangtools.yang.common.Revision;
  14 import org.opendaylight.yangtools.yang.data.api.schema.MountPointContextFactory;
  15
  16 /**
  17  * Main entry point into YANG (Module) Library support instance.
  18  */
  19 @Beta
  20 @NonNullByDefault
  21 public interface YangLibSupport {
  22     /**
  23      * Create a MountPointContextFactory, backed by a specific SchemaContextResolver.
  24      *
  25      * @param label Resulting Mount Point identifier
  26      * @param resolver SchemaContext resolver
  27      * @return A new factory
  28      * @throws NullPointerException if any argument is null
  29      */
  30     MountPointContextFactory createMountPointContextFactory(MountPointLabel label, SchemaContextResolver resolver);
  31
  32     /**
  33      * Return the revision date of the model this support implements. The value returned from this method is suitable
  34      * for reporting in <a href="https://tools.ietf.org/html/rfc8040#section-3.3.3">RFC8040 section 3.3.3</a>.
  35      *
  36      * @return A revision.
  37      */
  38     Revision implementedRevision();
  39
  40     /**
  41      * Create a new content builder which is used to serialize yang library content into NormalizedNodes.
  42      * This content builder has further options which can influence the resulting content.
  43      *
  44      * @return A new yang library content builder.
  45      */
  46     YangLibraryContentBuilder newContentBuilder();
  47 }