BindingGeneratorImpl Javadoc & code clean-up
[mdsal.git] / binding / mdsal-binding-generator-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  * @deprecated Use {@link org.opendaylight.mdsal.binding.model.api.TypeMember} instead.
16  */
17 @Deprecated
18 public interface TypeMember {
19
20     /**
21      * Returns comment string associated with member.
22      *
23      * @return comment string associated with member.
24      */
25     String getComment();
26
27     /**
28      * Returns List of annotation definitions associated with generated type.
29      *
30      * @return List of annotation definitions associated with generated type.
31      */
32     List<AnnotationType> getAnnotations();
33
34     /**
35      * Returns the access modifier of member.
36      *
37      * @return the access modifier of member.
38      */
39     AccessModifier getAccessModifier();
40
41     /**
42      * Returns <code>true</code> if member is declared as static.
43      *
44      * @return <code>true</code> if member is declared as static.
45      */
46     boolean isStatic();
47
48     /**
49      * Returns <code>true</code> if member is declared as final.
50      *
51      * @return <code>true</code> if member is declared as final.
52      */
53     boolean isFinal();
54
55     /**
56      * Get the returning Type of member.
57      *
58      * @return the returning Type of member.
59      */
60     Type getReturnType();
61
62     /**
63      * Returns the name of member.
64      *
65      * @return the name of member.
66      */
67     String getName();
68
69     /**
70      * Returns the Type that declares member.
71      *
72      * @return the Type that declares member.
73      */
74     Type getDefiningType();
75
76 }