opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/GeneratedType.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.controller.sal.binding.model.api;
   9
  10 import java.util.List;
  11
  12 /**
  13  * Every Java interface has to be specified with:
  14  * <ul>
  15  * <li><code>package</code> that belongs into</li>
  16  * <li><code>interface</code> name (with commentary that <b>SHOULD</b> be
  17  * present to proper define interface and base <i>contracts</i> specified for
  18  * interface)</li>
  19  * <li><code>enum</code> and <code>constant</code> definitions (i.e. each
  20  * constant definition is by default defined as <code>public static final</code>
  21  * + type (either primitive or object) and constant name</li>
  22  * <li><code>method definitions</code> with specified input parameters (with
  23  * types) and return values</li>
  24  * </ul>
  25  *
  26  * By the definition of the interface constant, enum and method definitions MUST
  27  * be public, so there is no need to specify the scope of visibility.
  28  *
  29  *
  30  */
  31 public interface GeneratedType extends Type {
  32
  33     public Type getParentType();
  34
  35     public String getComment();
  36
  37     public List<AnnotationType> getAnnotations();
  38
  39     public List<GeneratedType> getImplements();
  40
  41     /**
  42      * Returns Set of all Enumerator definitions associated with interface.
  43      *
  44      * @return Set of all Enumerator definitions associated with interface.
  45      */
  46     public List<Enumeration> getEnumDefintions();
  47
  48     /**
  49      *
  50      *
  51      * @return
  52      */
  53     public List<Constant> getConstantDefinitions();
  54
  55     /**
  56      *
  57      *
  58      * @return
  59      */
  60     public List<MethodSignature> getMethodDefinitions();
  61
  62 }