001: // Transmogrify License
002: //
003: // Copyright (c) 2001, ThoughtWorks, Inc.
004: // All rights reserved.
005: // Redistribution and use in source and binary forms, with or without
006: // modification, are permitted provided that the following conditions
007: // are met:
008: // - Redistributions of source code must retain the above copyright notice,
009: // this list of conditions and the following disclaimer.
010: // - Redistributions in binary form must reproduce the above copyright
011: // notice, this list of conditions and the following disclaimer in the
012: // documentation and/or other materials provided with the distribution.
013: // Neither the name of the ThoughtWorks, Inc. nor the names of its
014: // contributors may be used to endorse or promote products derived from this
015: // software without specific prior written permission.
016: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
017: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
018: // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
019: // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
020: // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
021: // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
022: // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
023: // OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
024: // WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
025: // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
026: // ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
027:
028: package com.puppycrawl.tools.checkstyle.checks.usage.transmogrify;
029:
030: import java.io.File;
031:
032: /**
033: * represents a place where a definition is used. There are two flavors
034: * of references -- resolved (those that have a definition associated with
035: * them) and unresolved (those that don't have a definition associated).
036: * The goal of the resolution step is to get all of the references in the
037: * symbol table to fall into the resolved category.
038: */
039:
040: public class Reference implements Comparable {
041:
042: private SymTabAST _node;
043: private Occurrence _occurrence;
044:
045: public Reference(SymTabAST node) {
046: _node = node;
047: _occurrence = new Occurrence(_node.getFile(), ASTUtil
048: .getLine(_node), ASTUtil.getColumn(_node));
049: }
050:
051: /**
052: * gets the definition associated with this reference
053: *
054: * @return Definition the (possibly null) definition associated with
055: * this reference
056: */
057: public IDefinition getDefinition() {
058: return _node.getDefinition();
059: }
060:
061: /**
062: * return the node that was passed in during ctor
063: */
064: public SymTabAST getTreeNode() {
065: return _node;
066: }
067:
068: /**
069: * gets the occurrence of this reference
070: *
071: * @return Occurrence
072: */
073: public Occurrence getOccurrence() {
074: return _occurrence;
075: }
076:
077: /**
078: * gets the line where the node resides
079: */
080: public int getLine() {
081: return getOccurrence().getLine();
082: }
083:
084: /**
085: * gets the column for where the node resides
086: */
087: public int getColumn() {
088: return getOccurrence().getColumn();
089: }
090:
091: /**
092: * gets the enclosing file for the node
093: */
094: public File getFile() {
095: return getOccurrence().getFile();
096: }
097:
098: /**
099: * gets the name of the reference
100: *
101: * @return String the name of the definition associated with this reference
102: * if this reference is resolved, else null
103: */
104: public String getName() {
105: return _node.getName();
106: }
107:
108: /**
109: * returns a string representation of the reference.
110: *
111: * @return String
112: */
113: public String toString() {
114: return getOccurrence().toString();
115: }
116:
117: /**
118: * returns whether the <code>Reference</code>s are equal
119: *
120: * @return whether the <code>Reference</code>s are equal
121: */
122: // REDTAG -- not finished
123: public boolean equals(Object obj) {
124: boolean result = false;
125: if (obj instanceof Reference) {
126: result = getOccurrence().equals(
127: ((Reference) obj).getOccurrence());
128: }
129: return result;
130: }
131:
132: public int compareTo(Object o) {
133: if (!(o instanceof Reference)) {
134: throw new ClassCastException(getClass().getName());
135: }
136:
137: return getOccurrence().compareTo(
138: ((Reference) o).getOccurrence());
139: }
140: }
|