KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > netbeans > api > gsf > PositionManager


1 /*
2  * The contents of this file are subject to the terms of the Common Development
3  * and Distribution License (the License). You may not use this file except in
4  * compliance with the License.
5  *
6  * You can obtain a copy of the License at http://www.netbeans.org/cddl.html
7  * or http://www.netbeans.org/cddl.txt.
8  *
9  * When distributing Covered Code, include this CDDL Header Notice in each file
10  * and include the License file at http://www.netbeans.org/cddl.txt.
11  * If applicable, add the following below the CDDL Header, with the fields
12  * enclosed by brackets [] replaced by your own identifying information:
13  * "Portions Copyrighted [year] [name of copyright owner]"
14  *
15  * The Original Software is NetBeans. The Initial Developer of the Original
16  * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
17  * Microsystems, Inc. All Rights Reserved.
18  */
19
20
21 package org.netbeans.api.gsf;
22
23 import org.netbeans.api.gsf.annotations.NonNull;
24 import org.netbeans.api.gsf.Element;
25
26 /**
27  * A PositionManager is responsible for mapping ComObjects provided by a Parser
28  * to an offset in the source buffer used by that parser.
29  * This service can often be provided by the parser itself (which would in that case
30  * implement this interface). Offsets are 0-based.
31  *
32  * @author Tor Norbye
33  */
34 public interface PositionManager {
35     /**
36      * Return the offset range of the given ComObject in the buffer, or OffsetRange.NONE
37      * if the ComObject is not found
38      */
39     @NonNull
40     OffsetRange getOffsetRange(Element file, Element object);
41 }
42
Popular Tags