binding/mdsal-binding-generator-api/src/main/java/org/opendaylight/yangtools/sal/binding/model/api/DocumentedType.java

   1 /*
   2  * Copyright (c) 2013 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.sal.binding.model.api;
   9
  10 import org.opendaylight.yangtools.yang.common.QName;
  11
  12 /**
  13  * Implementing this interface allows an object to hold information which are
  14  * essential for generating java doc from type definition.
  15  */
  16 public interface DocumentedType {
  17
  18     /**
  19      * Returns a string that contains a human-readable textual description of
  20      * type definition.
  21      *
  22      * @return a human-readable textual description of type definition.
  23      */
  24     String getDescription();
  25
  26     /**
  27      * Returns a string that is used to specify a textual cross-reference to an
  28      * external document, either another module that defines related management
  29      * information, or a document that provides additional information relevant
  30      * to this definition.
  31      *
  32      * @return a textual cross-reference to an external document.
  33      */
  34     String getReference();
  35
  36     /**
  37      * Returns a list of QNames which represent schema path in schema tree from
  38      * actual concrete type to the root.
  39      *
  40      * @return a schema path in schema tree from actual concrete schema node
  41      *         identifier to the root.
  42      */
  43     Iterable<QName> getSchemaPath();
  44
  45     /**
  46      * Returns the name of the module, in which generated type was specified.
  47      *
  48      * @return the name of the module, in which generated type was specified.
  49      */
  50     String getModuleName();
  51 }