opendaylight/sal/yang-prototype/code-generator/binding-model-api/src/main/java/org/opendaylight/controller/sal/binding/model/api/TypeMember.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 public interface TypeMember {
  13
  14     /**
  15      * Returns List of annotation definitions associated with generated type.
  16      *
  17      * @return List of annotation definitions associated with generated type.
  18      */
  19     public List<AnnotationType> getAnnotations();
  20
  21     /**
  22      * Returns the name of method.
  23      *
  24      * @return the name of method.
  25      */
  26     public String getName();
  27
  28     /**
  29      * Returns comment string associated with method.
  30      *
  31      * @return comment string associated with method.
  32      */
  33     public String getComment();
  34
  35     /**
  36      * Returns the Type that declares method.
  37      *
  38      * @return the Type that declares method.
  39      */
  40     public Type getDefiningType();
  41
  42     /**
  43      * Returns the access modifier of method.
  44      *
  45      * @return the access modifier of method.
  46      */
  47     public AccessModifier getAccessModifier();
  48
  49     /**
  50      * Returns the returning Type that methods returns.
  51      *
  52      * @return the returning Type that methods returns.
  53      */
  54     public Type getReturnType();
  55
  56     /**
  57      * Returns <code>true</code> if method is declared as final.
  58      *
  59      * @return <code>true</code> if method is declared as final.
  60      */
  61     public boolean isFinal();
  62 }