binding2/mdsal-binding2-generator-api/src/main/java/org/opendaylight/mdsal/binding2/model/api/TypeMember.java

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