2
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
4
* Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
6
* The contents of this file are subject to the terms of either the GNU
7
* General Public License Version 2 only ("GPL") or the Common
8
* Development and Distribution License("CDDL") (collectively, the
9
* "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]"
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.
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.
41
package org.netbeans.modules.php.model;
43
import java.util.List;
45
import javax.swing.text.Document;
47
import org.openide.util.Lookup.Provider;
51
* This is entry point for semantic access of PHP content.
52
* Model consist from set of management methods and
53
* information retrieval methods.
54
* This class is immutable for given Document ( it doesn't
55
* mutate when something changed in source ). So you can keep
56
* safely reference to it.
57
* All its information already is mutable. So you can't keep
58
* references to objects assuming they always available
59
* ( object can appear as removed ).
65
public interface PhpModel extends Acceptor, Provider {
68
* This method is called for syncronizing model with Document text
82
* This is main "informational" model method.
83
* The structure of content is very close to structure of pure PHP nbs file.
84
* @return ordered list of top level language structures. Statement could
85
* be some block, class def, ....
87
List<Statement> getStatements();
89
<T extends Statement> List<T> getStatements( Class<T> clazz );
91
Document getDocument();
94
* Finder method for searching model source element by given offset in Document.
95
* @param offset offset of searched element
96
* @return source element at <code>offset</code>
98
SourceElement findSourceElement( int offset );