001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041: package org.netbeans.modules.refactoring.api;
042:
043: import java.util.Hashtable;
044: import org.netbeans.modules.refactoring.api.*;
045: import org.openide.util.Lookup;
046:
047: /**
048: * Where used query does not do any "real" refactoring.
049: * It just encapsulates parameters for Find Usages, which is implemented by
050: * plugins.
051: * Refactoring itself is implemented in plugins
052: * @see org.netbeans.modules.refactoring.spi.RefactoringPlugin
053: * @see org.netbeans.modules.refactoring.spi.RefactoringPluginFactory
054: * @see AbstractRefactoring
055: * @see RefactoringSession
056: * @author Jan Becicka
057: */
058: public final class WhereUsedQuery extends AbstractRefactoring {
059: /**
060: * key for {@link getBooleanValue()}
061: * is search in comments requested?
062: */
063: public static final String SEARCH_IN_COMMENTS = "SEARCH_IN_COMMENTS"; // NOI18N
064: /**
065: * key for {@link getBooleanValue()}
066: * is find references requested?
067: */
068: public static final String FIND_REFERENCES = "FIND_REFERENCES"; // NOI18N
069:
070: /**
071: * Creates a new instance of WhereUsedQuery.
072: * WhereUsedQuery implementations currently understand following types:
073: * <table border="1">
074: * <tr><th>Module</th><th>Types the Module Understands</th><th>Implementation</th></tr>
075: * <tr><td>Java Refactoring</td><td><ul>
076: * <li>{@link org.openide.filesystems.FileObject} with content type text/x-java (class references)
077: * <li>{@link org.netbeans.api.java.source.TreePathHandle} (class, field, method references)
078: * </ul>
079: * <td>Finds references</td></tr>
080: * </table>
081: * @param lookup put object for which you request references into Lookup instance.
082: */
083: public WhereUsedQuery(Lookup lookup) {
084: super (lookup);
085: putValue(FIND_REFERENCES, true);
086: }
087:
088: /**
089: * Setter for searched item
090: * @param lookup put object for which you request references into Lookup instance.
091: */
092: public final void setRefactoringSource(Lookup lookup) {
093: this .refactoringSource = lookup;
094: }
095:
096: private Hashtable hash = new Hashtable();
097:
098: /**
099: * getter for various properties
100: * @param key
101: * @return value for given key
102: * @see WhereUsedQuery#SEARCH_IN_COMMENTS
103: * @see WhereUsedQuery#FIND_REFERENCES
104: */
105: public final boolean getBooleanValue(Object key) {
106: Object o = hash.get(key);
107: if (o instanceof Boolean)
108: return (Boolean) o;
109: return false;
110: }
111:
112: /**
113: * setter for various properties
114: * @param key
115: * @param value set value for given key
116: * @see WhereUsedQuery#SEARCH_IN_COMMENTS
117: * @see WhereUsedQuery#FIND_REFERENCES
118: */
119: public final void putValue(Object key, Object value) {
120: hash.put(key, value);
121: }
122: }
|