yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/SchemaRepository.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/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.repo.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.util.concurrent.CheckedFuture;
  12 import javax.annotation.Nonnull;
  13 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  14
  15 /**
  16  * Interface exposed by repository implementations. A schema repository is a logically
  17  * centralized place for model storage and creation of {@link SchemaContext} instances.
  18  */
  19 @Beta
  20 public interface SchemaRepository {
  21     /**
  22      * Instantiate a new {@link SchemaContextFactory}, which will filter available schema
  23      * sources using the provided filter.
  24      *
  25      * @param filter Filter which acts as the gating function before a schema source is
  26      *               considered by the factory for inclusion in the {@link SchemaContext}
  27      *               it produces.
  28      * @return A new schema context factory.
  29      */
  30     SchemaContextFactory createSchemaContextFactory(@Nonnull SchemaSourceFilter filter);
  31
  32     <T extends SchemaSourceRepresentation> CheckedFuture<T, SchemaSourceException> getSchemaSource(
  33             @Nonnull SourceIdentifier id, @Nonnull Class<T> represetation);
  34 }