yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/impl/DefaultReactors.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, 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.yang.parser.impl;
   9
  10 import static org.opendaylight.yangtools.yang.parser.spi.meta.NamespaceBehaviour.treeScoped;
  11
  12 import com.google.common.annotations.Beta;
  13 import org.opendaylight.yangtools.yang.parser.odlext.namespace.AnyxmlSchemaLocationNamespace;
  14 import org.opendaylight.yangtools.yang.parser.odlext.stmt.AnyxmlSchemaLocationSupport;
  15 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.CustomCrossSourceStatementReactorBuilder;
  16 import org.opendaylight.yangtools.yang.parser.rfc7950.reactor.RFC7950Reactors;
  17 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  18 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor;
  19 import org.opendaylight.yangtools.yang.parser.stmt.reactor.CrossSourceStatementReactor.Builder;
  20 import org.opendaylight.yangtools.yang.parser.stmt.rfc8040.YangDataStatementSupport;
  21
  22 /**
  23  * Utility class for instantiating default-configured {@link CrossSourceStatementReactor}s.
  24  *
  25  * @author Robert Varga
  26  */
  27 @Beta
  28 public final class DefaultReactors {
  29     private static final CrossSourceStatementReactor DEFAULT_REACTOR = defaultReactorBuilder().build();
  30
  31     private DefaultReactors() {
  32         throw new UnsupportedOperationException();
  33     }
  34
  35     /**
  36      * Get a shared default-configured reactor instance. This instance is configured to handle both RFC6020 and RFC7950,
  37      * as well as RFC8040's yang-data extension.
  38      *
  39      * @return a shared default-configured reactor instance.
  40      */
  41     public static CrossSourceStatementReactor defaultReactor() {
  42         return DEFAULT_REACTOR;
  43     }
  44
  45     /**
  46      * Return a baseline CrossSourceStatementReactor {@link Builder}. The builder is initialized to the equivalent
  47      * of the reactor returned via {@link #defaultReactor()}, but can be further customized before use.
  48      *
  49      * @return A populated CrossSourceStatementReactor builder.
  50      */
  51     public static CustomCrossSourceStatementReactorBuilder defaultReactorBuilder() {
  52         return RFC7950Reactors.defaultReactorBuilder()
  53                 // AnyxmlSchemaLocation support
  54                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, AnyxmlSchemaLocationSupport.getInstance())
  55                 .addNamespaceSupport(ModelProcessingPhase.FULL_DECLARATION,
  56                     treeScoped(AnyxmlSchemaLocationNamespace.class))
  57                 // RFC8040 yang-data support.
  58                 .addStatementSupport(ModelProcessingPhase.FULL_DECLARATION, YangDataStatementSupport.getInstance());
  59     }
  60 }