code-generator/binding-model-api/src/main/java/org/opendaylight/yangtools/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.yangtools.sal.binding.model.api;
   9
  10 import java.util.List;
  11
  12 /**
  13  * Common interface for variables and methods in class.
  14  */
  15 public interface TypeMember {
  16
  17     /**
  18      * Returns comment string associated with member.
  19      *
  20      * @return comment string associated with member.
  21      */
  22     String getComment();
  23
  24     /**
  25      * Returns List of annotation definitions associated with generated type.
  26      *
  27      * @return List of annotation definitions associated with generated type.
  28      */
  29     List<AnnotationType> getAnnotations();
  30
  31     /**
  32      * Returns the access modifier of member.
  33      *
  34      * @return the access modifier of member.
  35      */
  36     AccessModifier getAccessModifier();
  37
  38     /**
  39      * Returns <code>true</code> if member is declared as static.
  40      *
  41      * @return <code>true</code> if member is declared as static.
  42      */
  43     boolean isStatic();
  44
  45     /**
  46      * Returns <code>true</code> if member is declared as final.
  47      *
  48      * @return <code>true</code> if member is declared as final.
  49      */
  50     boolean isFinal();
  51
  52     /**
  53      * Get the returning Type of member.
  54      *
  55      * @return the returning Type of member.
  56      */
  57     Type getReturnType();
  58
  59     /**
  60      * Returns the name of member.
  61      *
  62      * @return the name of member.
  63      */
  64     String getName();
  65
  66     /**
  67      * Returns the Type that declares member.
  68      *
  69      * @return the Type that declares member.
  70      */
  71     Type getDefiningType();
  72
  73 }