yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/repo/api/YinSchemaSource.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 org.w3c.dom.Document;
  12
  13 /**
  14  * Yin schema source representation. Exposes an RFC6020 YIN XML representation
  15  * as an W3C {@link Document}.
  16  */
  17 @Beta
  18 public interface YinSchemaSource extends SchemaSourceRepresentation {
  19     /**
  20      * {@inheritDoc}
  21      */
  22     @Override
  23     SourceIdentifier getIdentifier();
  24
  25     /**
  26      * {@inheritDoc}
  27      */
  28     @Override
  29     Class<? extends YinSchemaSource> getType();
  30
  31     /**
  32      * Return schema source as a Yin-compliant Document.
  33      *
  34      * @return W3C DOM document.
  35      */
  36     Document getYinDocument();
  37 }