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