Source code: com/puppycrawl/tools/checkstyle/checks/usage/transmogrify/Reference.java
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 java.io.File;
32
33
34
35
36 /**
37 * represents a place where a definition is used. There are two flavors
38 * of references -- resolved (those that have a definition associated with
39 * them) and unresolved (those that don't have a definition associated).
40 * The goal of the resolution step is to get all of the references in the
41 * symbol table to fall into the resolved category.
42 */
43
44 public class Reference implements Comparable {
45
46 private SymTabAST _node;
47 private Occurrence _occurrence;
48
49 public Reference( SymTabAST node ) {
50 _node = node;
51 _occurrence = new Occurrence( _node.getFile(), ASTUtil.getLine(_node), ASTUtil.getColumn(_node) );
52 }
53
54 private void method() {
55 }
56
57 /**
58 * gets the definition associated with this reference
59 *
60 * @return Definition the (possibly null) definition associated with
61 * this reference
62 */
63 public IDefinition getDefinition() {
64 return _node.getDefinition();
65 }
66
67 /**
68 * return the node that was passed in during ctor
69 */
70 public SymTabAST getTreeNode() {
71 return _node;
72 }
73
74 /**
75 * gets the occurrence of this reference
76 *
77 * @return Occurrence
78 */
79 public Occurrence getOccurrence() {
80 return _occurrence;
81 }
82
83 /**
84 * gets the line where the node resides
85 */
86 public int getLine() {
87 return getOccurrence().getLine();
88 }
89
90 /**
91 * gets the column for where the node resides
92 */
93 public int getColumn() {
94 return getOccurrence().getColumn();
95 }
96
97 /**
98 * gets the enclosing file for the node
99 */
100 public File getFile() {
101 return getOccurrence().getFile();
102 }
103
104 /**
105 * gets the name of the reference
106 *
107 * @return String the name of the definition associated with this reference
108 * if this reference is resolved, else null
109 */
110 public String getName() {
111 return _node.getName();
112 }
113
114 /**
115 * returns a string representation of the reference.
116 *
117 * @return String
118 */
119 public String toString() {
120 return getOccurrence().toString();
121 }
122
123 /**
124 * returns whether the <code>Reference</code>s are equal
125 *
126 * @return whether the <code>Reference</code>s are equal
127 */
128 // REDTAG -- not finished
129 public boolean equals(Object obj){
130 boolean result = false;
131 if (obj instanceof Reference) {
132 result = getOccurrence().equals(((Reference)obj).getOccurrence());
133 }
134 return result;
135 }
136
137 public int compareTo(Object o) {
138 if (!(o instanceof Reference)) {
139 throw new ClassCastException(getClass().getName());
140 }
141
142 return getOccurrence().compareTo(((Reference)o).getOccurrence());
143 }
144 }