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.spi.lexer;
43:
44: /**
45: * Defines whether a default embedding can be present for the given token id or not.
46: * <br/>
47: * It allows to speed up <code>TokenSequence.embedded()</code> calls considerably in most cases.
48: * <br/>
49: * This only affects the default embedding creation. Custom embedding creation
50: * can always be performed by <code>TokenSequene.createEmbedding()</code>.
51: *
52: * @author Miloslav Metelka
53: */
54:
55: public enum EmbeddingPresence {
56:
57: /**
58: * Creation of the default embedding for the particular {@link org.netbeans.api.lexer.TokenId}
59: * will be attempted for the first time but if there will be no embedding
60: * created then there will be no other attempts for embedding creation
61: * for any tokens with the same token id.
62: * <br/>
63: * This corresponds to the most usual case that the embedding presence
64: * only depends on a token id.
65: * <br/>
66: * This is the default for {@link LanguageHierarchy#embeddingPresence(org.netbeans.api.lexer.TokenId)}.
67: */
68: CACHED_FIRST_QUERY,
69:
70: /**
71: * Default embedding creation will always be attempted for each token since
72: * the embedding presence varies (it may depend on token's text or other token properties).
73: * <br/>
74: * For example if a string literal token would only qualify for an embedding
75: * if it would contain a '\' character but not otherwise then this method
76: * should return true for string literal token id.
77: * <br/>
78: * This option presents no performance improvement.
79: */
80: ALWAYS_QUERY,
81:
82: /**
83: * There is no default embedding for the given {@link org.netbeans.api.lexer.TokenId}
84: * and its creation will not be attempted.
85: * <br/>
86: * This is useful e.g. for keywords and operators.
87: */
88: NONE,
89:
90: }
|