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-2007 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.lib.lexer.inc;
43:
44: import org.netbeans.api.lexer.TokenId;
45: import org.netbeans.lib.lexer.LexerInputOperation;
46: import org.netbeans.lib.lexer.TokenList;
47:
48: /**
49: * Token list that allows mutating by token list mutator.
50: *
51: * @author Miloslav Metelka
52: * @version 1.00
53: */
54:
55: public interface MutableTokenList<T extends TokenId> extends
56: TokenList<T> {
57:
58: /**
59: * Return token or branch token list at the requested index
60: * but do not synchronize the access - there should only be one thread
61: * accessing the token list at this time.
62: * Also do not perform any checks regarding index validity
63: * - only items below {@link #tokenCountCurrent()} will be requested.
64: */
65: Object tokenOrEmbeddingContainerUnsync(int index);
66:
67: /**
68: * Create lexer input operation used for relexing of the input.
69: */
70: LexerInputOperation<T> createLexerInputOperation(int tokenIndex,
71: int relexOffset, Object relexState);
72:
73: /**
74: * Check whether the whole input was tokenized or not.
75: * <br/>
76: * Incremental algorithm uses this information to determine
77: * whether it should relex the input till the end or not.
78: */
79: boolean isFullyLexed();
80:
81: /**
82: * Update the token list by replacing tokens according to the given change.
83: */
84: void replaceTokens(TokenListChange<T> change, int removeTokenCount,
85: int diffLength);
86:
87: }
|