KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > usage > transmogrify > VariableDef


1
2 // Transmogrify License
3 //
4 // Copyright (c) 2001, ThoughtWorks, Inc.
5 // All rights reserved.
6 // Redistribution and use in source and binary forms, with or without
7 // modification, are permitted provided that the following conditions
8 // are met:
9 // - Redistributions of source code must retain the above copyright notice,
10 // this list of conditions and the following disclaimer.
11 // - Redistributions in binary form must reproduce the above copyright
12 // notice, this list of conditions and the following disclaimer in the
13 // documentation and/or other materials provided with the distribution.
14 // Neither the name of the ThoughtWorks, Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from this
16 // software without specific prior written permission.
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
19 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
27 // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29 package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
30
31 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
32
33
34
35 /**
36  * <code>VariableDef</code> is a <code>Definition</code> that contains
37  * information about the definition of a variable.
38  *
39  * @see Definition
40  * @see TypedDef
41  */
42 public class VariableDef extends Definition implements IVariable {
43
44     public static final int PRIVATE_VISIBILITY = 0;
45     public static final int PROTECTED_VISIBILITY = 1;
46     public static final int PUBLIC_VISIBILITY = 2;
47     public static final int DEFAULT_VISIBILITY = 3;
48
49     private IClass _type = null;
50
51     public VariableDef(String JavaDoc name, Scope parentScope, SymTabAST node) {
52         super(name, parentScope, node);
53     }
54
55     /**
56      * Returns the <code>Type</code> of the variable.
57      *
58      * @see TypedDef
59      *
60      * @return the <code>Type</code> of the variable
61      */
62     public IClass getType() {
63         return _type;
64     }
65
66     /**
67      * Sets the type of the variable.
68      *
69      * @see TypedDef
70      *
71      * @param def the <code>Type</code> object that represents the type of the
72      * variable.
73      */
74     public void setType(IClass type) {
75         _type = type;
76     }
77
78     public int getVisibility() {
79         int result = DEFAULT_VISIBILITY;
80
81         SymTabAST visibilityNode = getVisibilityNode();
82         if (visibilityNode != null) {
83             if (visibilityNode.getType() == TokenTypes.LITERAL_PRIVATE) {
84                 result = PRIVATE_VISIBILITY;
85             }
86             else if (
87                 visibilityNode.getType() == TokenTypes.LITERAL_PROTECTED) {
88                 result = PROTECTED_VISIBILITY;
89             }
90             else if (visibilityNode.getType() == TokenTypes.LITERAL_PUBLIC) {
91                 result = PUBLIC_VISIBILITY;
92             }
93         }
94
95         return result;
96     }
97
98     private SymTabAST getVisibilityNode() {
99         SymTabAST result = null;
100
101         SymTabAST modifiersNode =
102             getTreeNode().findFirstToken(TokenTypes.MODIFIERS);
103         SymTabAST modifier = (SymTabAST) modifiersNode.getFirstChild();
104         while (modifier != null) {
105             if (isVisibilityNode(modifier)) {
106                 result = modifier;
107                 break;
108             }
109             modifier = (SymTabAST) modifier.getNextSibling();
110         }
111
112         return result;
113     }
114
115     private boolean isVisibilityNode(SymTabAST node) {
116         return (
117             node.getType() == TokenTypes.LITERAL_PUBLIC
118                 || node.getType() == TokenTypes.LITERAL_PROTECTED
119                 || node.getType() == TokenTypes.LITERAL_PRIVATE);
120     }
121
122     public boolean isAssignedAtDeclaration() {
123         boolean result = false;
124
125         if (getTreeNode().findFirstToken(TokenTypes.ASSIGN) != null) {
126             result = true;
127         }
128
129         return result;
130     }
131
132 }
133
Popular Tags