yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaContextFactory.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. 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/eplv10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.repo.api;
   9
  10 import com.google.common.util.concurrent.CheckedFuture;
  11
  12 import java.util.Collection;
  13
  14 import javax.annotation.Nonnull;
  15
  16 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  17
  18 /**
  19  * An asynchronous factory for building {@link SchemaContext} instances
  20  * based on a specification of what {@link SourceIdentifier}s are required
  21  * and dynamic recursive resolution.
  22  */
  23 public interface SchemaContextFactory {
  24     /**
  25      * Create a new schema context containing specified sources, pulling in
  26      * any dependencies they may have.
  27      *
  28      * @param requiredSources a collection of sources which are required to
  29      *                        be present
  30      * @return A checked future, which will produce a schema context, or
  31      *         fail with an explanation why the creation of the schema context
  32      *         failed.
  33      */
  34     CheckedFuture<SchemaContext, SchemaResolutionException> createSchemaContext(@Nonnull Collection<SourceIdentifier> requiredSources);
  35 }