/* * Copyright (c) 2014 Cisco Systems, Inc. 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.yang.model.repo.api; import com.google.common.annotations.Beta; import java.util.Optional; import org.eclipse.jdt.annotation.NonNull; import org.opendaylight.yangtools.concepts.Identifiable; import org.opendaylight.yangtools.concepts.Immutable; /** * Common interface for schema source representations. A schema source is an atomic piece of the overall schema context. * In YANG terms, a schema source is semantically equivalent to a single YANG text file, be it a module or a submodule. * *
* A schema source can exist in various forms, which we call representations. Again, in YANG terms, each representation * is semantically equivalent, but from implementation perspective certain operations on a schema source may require it * to be first transformed into a particular representation before they can be applied. Such transformations are * affected via instances of SchemaSourceTransformation. * *
* Typical examples of a schema source representation include: *
* Implementations of this interface expected to comply with the {@link Immutable} contract.
*/
@Beta
public interface SchemaSourceRepresentation extends Identifiable