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.javadoc.search;
043:
044: import java.io.IOException;
045: import java.io.NotSerializableException;
046: import java.io.ObjectOutputStream;
047: import java.io.ObjectStreamException;
048: import java.io.Serializable;
049: import org.openide.filesystems.FileObject;
050:
051: /* Base class providing search for JDK1.2/1.3 documentation
052: * @author Petr Hrebejk, Petr Suchomel
053: */
054: public class Jdk12SearchType extends JavadocSearchType implements
055: Serializable {
056:
057: private boolean caseSensitive = true;
058:
059: /** generated Serialized Version UID */
060: private static final long serialVersionUID = -2453877778724454324L;
061:
062: /** Getter for property caseSensitive.
063: * @return Value of property caseSensitive.
064: */
065: public boolean isCaseSensitive() {
066: return caseSensitive;
067: }
068:
069: /** Setter for property caseSensitive.
070: * @param caseSensitive New value of property caseSensitive.
071: */
072: public void setCaseSensitive(boolean caseSensitive) {
073: boolean oldVal = this .caseSensitive;
074: this .caseSensitive = caseSensitive;
075: // this.firePropertyChange("caseSensitive", oldVal ? Boolean.TRUE : Boolean.FALSE, caseSensitive ? Boolean.TRUE : Boolean.FALSE); //NOI18N
076: }
077:
078: public FileObject getDocFileObject(FileObject apidocRoot) {
079:
080: FileObject fo = apidocRoot.getFileObject("index-files"); // NOI18N
081: if (fo != null) {
082: return fo;
083: }
084:
085: fo = apidocRoot.getFileObject("index-all.html"); // NOI18N
086: if (fo != null) {
087: return fo;
088: }
089:
090: return null;
091: }
092:
093: /** Returns Java doc search thread for doument
094: * @param toFind String to find
095: * @param fo File object containing index-files
096: * @param diiConsumer consumer for parse events
097: * @return IndexSearchThread
098: * @see IndexSearchThread
099: */
100: public IndexSearchThread getSearchThread(String toFind,
101: FileObject fo,
102: IndexSearchThread.DocIndexItemConsumer diiConsumer) {
103: return new SearchThreadJdk12(toFind, fo, diiConsumer,
104: isCaseSensitive());
105: }
106:
107: public boolean accepts(FileObject apidocRoot, String encoding) {
108: //XXX returns always true, must be the last JavadocType
109: return true;
110: }
111:
112: /**
113: * Replaces old serialized service type with a dummy instance to prevent
114: * exceptions from the Lookup
115: */
116: @Deprecated
117: protected final Object readResolve() throws ObjectStreamException {
118: // replace old serializable component with dummy instance
119: // to prevent exceptions from the Lookup
120: return new JavadocSearchType() {
121:
122: @Override
123: public FileObject getDocFileObject(FileObject apidocRoot) {
124: return null;
125: }
126:
127: @Override
128: public IndexSearchThread getSearchThread(String toFind,
129: FileObject fo,
130: IndexSearchThread.DocIndexItemConsumer diiConsumer) {
131:
132: return null;
133: }
134:
135: @Override
136: public boolean accepts(FileObject apidocRoot,
137: String encoding) {
138: return false;
139: }
140: };
141: }
142:
143: /**
144: * Warns not to serialize it.
145: */
146: @Deprecated
147: private void writeObject(ObjectOutputStream out) throws IOException {
148: throw new NotSerializableException(this.getClass().getName());
149: }
150:
151: }
|