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-2007 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:
042: package org.netbeans.modules.cnd.api.model.services;
043:
044: import java.util.EnumSet;
045: import org.netbeans.modules.cnd.api.model.CsmScope;
046: import org.netbeans.modules.cnd.api.model.xref.CsmReference;
047: import org.netbeans.modules.cnd.api.model.xref.CsmReferenceKind;
048: import org.openide.util.Lookup;
049:
050: /**
051: * Provides a list of CsmReferences of the identifiers in the CsmFile
052: *
053: * @author Sergey Grinev
054: */
055: public abstract class CsmFileReferences {
056: /**
057: * Provides visiting of the identifiers of the CsmFile
058: */
059: public abstract void accept(CsmScope csmScope, Visitor visitor);
060:
061: /**
062: * Provides visiting of the identifiers of the CsmFile and point prefered
063: * kinds of references
064: */
065: public abstract void accept(CsmScope csmScope, Visitor visitor,
066: EnumSet<CsmReferenceKind> preferedKinds);
067:
068: /**
069: * A dummy resolver that do nothing.
070: */
071: private static final CsmFileReferences EMPTY = new Empty();
072:
073: /** default instance */
074: private static CsmFileReferences DEFAULT;
075:
076: protected CsmFileReferences() {
077: }
078:
079: /** Static method to obtain the CsmFileReferences implementation.
080: * @return the resolver
081: */
082: public static synchronized CsmFileReferences getDefault() {
083: if (DEFAULT != null) {
084: return DEFAULT;
085: }
086: DEFAULT = Lookup.getDefault().lookup(CsmFileReferences.class);
087: return DEFAULT == null ? EMPTY : DEFAULT;
088: }
089:
090: //
091: // Implementation of the default query
092: //
093: private static final class Empty extends CsmFileReferences {
094: Empty() {
095: }
096:
097: @Override
098: public void accept(CsmScope csmScope, Visitor visitor) {
099: // do nothing
100: }
101:
102: @Override
103: public void accept(CsmScope csmScope, Visitor visitor,
104: EnumSet<CsmReferenceKind> kinds) {
105: // do nothing
106: }
107: }
108:
109: /**
110: * visitor inteface
111: */
112: public interface Visitor {
113: void visit(CsmReference ref);
114: }
115: }
|