org.opendaylight.yangtools.binding.runtime.api.ModuleInfoSnapshot Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of binding-runtime-api Show documentation

YANG Binding runtime API

The newest version!

/*
 * Copyright (c) 2020 PANTHEON.tech, s.r.o. and others.  All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
 * and is available at http://www.eclipse.org/legal/epl-v10.html
 */
package org.opendaylight.yangtools.binding.runtime.api;

import com.google.common.annotations.Beta;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.opendaylight.yangtools.binding.meta.YangModuleInfo;
import org.opendaylight.yangtools.concepts.Immutable;
import org.opendaylight.yangtools.yang.model.api.EffectiveModelContext;
import org.opendaylight.yangtools.yang.model.api.source.SourceIdentifier;
import org.opendaylight.yangtools.yang.model.api.source.YangTextSource;
import org.opendaylight.yangtools.yang.model.repo.api.MissingSchemaSourceException;

/**
 * A snapshot of a set of {@link YangModuleInfo}s, assembled to form an {@link EffectiveModelContext}.
 */
@Beta
@NonNullByDefault
public interface ModuleInfoSnapshot extends Immutable {
    /**
     * The {@link EffectiveModelContext} resulting from all models exposed from constituent module infos.
     *
     * @return the resulting model context
     */
    EffectiveModelContext modelContext();

    @Nullable YangTextSource yangTextSource(SourceIdentifier sourceId);

    YangTextSource getYangTextSource(SourceIdentifier sourceId) throws MissingSchemaSourceException;

     Class loadClass(String fullyQualifiedName) throws ClassNotFoundException;
}