01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.php.editor.completion;
43:
44: import java.util.Set;
45: import org.netbeans.modules.gsf.api.Element;
46: import org.netbeans.modules.gsf.api.ElementKind;
47: import org.netbeans.modules.gsf.api.Modifier;
48:
49: /**
50: * An abstraction for the <code>Element</code> that has the associated
51: * documentation.
52: * <p>
53: * <b>Note:</b> Note: All implementations of the <code>Element</code> interface
54: * methods return <code>null</code>. These methods might be overridden by a
55: * successor of this class if it is needed.
56: * </p>
57: *
58: * @author Victor G. Vasilyev
59: */
60: public abstract class DocumentableElement implements Element {
61:
62: public String getName() {
63: return null;
64: }
65:
66: public String getIn() {
67: return null;
68: }
69:
70: public ElementKind getKind() {
71: return null;
72: }
73:
74: public Set<Modifier> getModifiers() {
75: return null;
76: }
77:
78: /**
79: * Returns documentation associated with the underlying <code>Element</code>
80: * in the HTML form.
81: * @return HTML documentation if it posible, otherwise <code>null</code>.
82: */
83: public abstract String getDocumentation();
84:
85: }
|