oracle.javatools.parser.java.v2

Class JavaParser

java.lang.Object

oracle.javatools.parser.java.v2.JavaParser

public class JavaParser
extends java.lang.Object

Raw API for generating parse trees.

Field Summary

Fields

Modifier and Type	Field and Description
static byte	j2se Deprecated. Use getJdkVersion() instead
static java.lang.String	JOT_JDKVERSION_OVERRIDE The name of the System property to set if the caller wants to override the JDK version JOT uses for parsing.

Constructor Summary

Constructors

Constructor and Description
JavaParser()

Method Summary

Modifier and Type	Method and Description
static boolean	cancelParse(java.lang.Thread thread) Attempt to cancel the parse running on the thread indicated by the incoming 'thread' parameter.
static JdkVersion	getJdkOfIde() Get the version of the JDK used to run the IDE.
static JdkVersion	getJdkVersion()
static java.util.logging.Logger	getLogger()
static JavaFile	lightParse(ReadTextBuffer textBuffer, java.net.URL url, JavaProvider javaProvider, int j2se) Deprecated. Use lightParse( ReadTextBuffer, URL, JavaProvider, JdkVersion ) instead
static JavaFile	lightParse(ReadTextBuffer textBuffer, java.net.URL url, JavaProvider javaProvider, JdkVersion jdkVersion) Parse the textBuffer and return a "light" sourceFile where all the method bodies were skipped In general this method should NOT be called directly.
static SourceFile	parse(ReadTextBuffer textBuffer) Parses the given text buffer with default options.
static SourceFile	parse(ReadTextBuffer textBuffer, int j2se) Deprecated. Use parse( ReadTextBuffer, JdkVersion ) instead
static SourceFile	parse(ReadTextBuffer textBuffer, JdkVersion jdkVersion) Parses the given text buffer with default options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JOT_JDKVERSION_OVERRIDE

public static final java.lang.String JOT_JDKVERSION_OVERRIDE

The name of the System property to set if the caller wants to override the JDK version JOT uses for parsing. Normally the JDK version is determined from the compiler settings of the project. This override is useful if the caller wants to use a specific JDK version, but (s)he has no control over the code that calls into this JavaParser, or if the caller wants to use a JDK version that is higher than the one allowed by the project settings. You can use "1.X" values to indicate the JDK version, but JDK versions from JDK9 on will drop the leading '1.', so a single value bigger than 1 can be used as well, e.g. to set the JDK version to JDK 1.8 (JDK 8) use: System.setProperty( JavaParser.JOT_JDKVERSION_OVERRIDE, "1.8" ); or to set it to JDK 9, use: System.setProperty( JavaParser.JOT_JDKVERSION_OVERRIDE, "9" );

See Also:

Constant Field Values

j2se

@Deprecated
public static byte j2se

Deprecated. Use getJdkVersion() instead

The JavaTokens.J2SE_XXX value indicating the JDK used for syntax validation.

Constructor Detail

JavaParser

public JavaParser()

Method Detail

getJdkOfIde

public static JdkVersion getJdkOfIde()

Get the version of the JDK used to run the IDE.

Returns:

A JdkVersion which will not be null

getJdkVersion

public static JdkVersion getJdkVersion()

parse

public static SourceFile parse(ReadTextBuffer textBuffer)

Parses the given text buffer with default options. NOTE: the returned SourceFile cannot be compiled since it doesn't have a JavaProvider for name resolutions. Use JavaManager.getSourceFile( TextBuffer ) instead. NOTE: this parser will use the default JDK version for syntax validation. Use parse( ReadTextBuffer, JdkVersion ) to do a parse for a specific JDK version. In general this method should NOT be called. Instead, use JavaManager.getSourceFile(TextBuffer).

parse

@Deprecated
public static SourceFile parse(ReadTextBuffer textBuffer,
                                           int j2se)

Deprecated. Use parse( ReadTextBuffer, JdkVersion ) instead

Parses the given text buffer with default options. NOTE: the returned SourceFile cannot be compiled since it doesn't have a JavaProvider for name resolutions. Use JavaManager.getSourceFile( TextBuffer ) instead. In general this method should NOT be called. Instead, use JavaManager.getSourceFile(TextBuffer).

Parameters:

j2se - The JDK version used for syntax validation, use one of JavaTokens.J2SE_*.

parse

public static SourceFile parse(ReadTextBuffer textBuffer,
                               JdkVersion jdkVersion)

Parses the given text buffer with default options. NOTE: the returned SourceFile cannot be compiled since it doesn't have a JavaProvider for name resolutions. Use JavaManager.getSourceFile( TextBuffer ) instead. In general this method should NOT be called. Instead, use JavaManager.getSourceFile(TextBuffer).

Parameters:

jdkVersion - The desired JDK version used for syntax validation

lightParse

@Deprecated
public static JavaFile lightParse(ReadTextBuffer textBuffer,
                                              java.net.URL url,
                                              JavaProvider javaProvider,
                                              int j2se)

Deprecated. Use lightParse( ReadTextBuffer, URL, JavaProvider, JdkVersion ) instead

Parse the textBuffer and return a "light" sourceFile where all the method bodies were skipped In general this method should NOT be called directly. Instead, use JavaManager.getFile(URL) which sets the correct options based on the project.

Parameters:

textBuffer - A text buffer, which cannot be null

url - The URL associated with the textBuffer, if there is such a URL

javaProvider - The JavaProvider which can be used to resolve types after the parse, if there is such a JavaProvider

j2se - The Java Version, one of JavaTokens.J2SE_*

Returns:

A "light" SourceFile returned as a JavaFile

lightParse

public static JavaFile lightParse(ReadTextBuffer textBuffer,
                                  java.net.URL url,
                                  JavaProvider javaProvider,
                                  JdkVersion jdkVersion)

Parse the textBuffer and return a "light" sourceFile where all the method bodies were skipped In general this method should NOT be called directly. Instead, use JavaManager.getFile(URL) which sets the correct options based on the project.

Parameters:

textBuffer - A text buffer, which cannot be null

url - The URL associated with the textBuffer, if there is such a URL

javaProvider - The JavaProvider which can be used to resolve types after the parse, if there is such a JavaProvider

jdkVersion - The desired JDK version used for syntax validation

Returns:

A "light" SourceFile returned as a JavaFile

cancelParse

public static boolean cancelParse(java.lang.Thread thread)

Attempt to cancel the parse running on the thread indicated by the incoming 'thread' parameter. If the parser actually cancels the parse, it will throw a CancellationException on the thread indicated by the incoming 'thread' parameter.

Parameters:

thread - A thread that is currently parsing

Returns:

True if the parser was notified of the cancellation, false otherwise, usually because there was no parser associated with the incoming 'thread' parameter. Notification of cancellation is no guarantee that the parser can actually cancel the parse.

getLogger

public static java.util.logging.Logger getLogger()