org.aspectj.org.eclipse.jdt.core

Class ToolFactory

java.lang.Object

org.aspectj.org.eclipse.jdt.core.ToolFactory

public class ToolFactory
extends java.lang.Object

Factory for creating various compiler tools, such as scanners, parsers and compilers.

This class provides static methods only.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static int	M_FORMAT_EXISTING This mode is used for formatting existing code when all formatter options should be used.
static int	M_FORMAT_NEW This mode is used for formatting new code when some formatter options should not be used.

Constructor Summary

Constructors

Constructor and Description
ToolFactory()

Method Summary

Modifier and Type	Method and Description
static ICodeFormatter	createCodeFormatter() Deprecated. The extension point has been deprecated, use createCodeFormatter(Map) instead.
static CodeFormatter	createCodeFormatter(java.util.Map options) Create an instance of the built-in code formatter.
static CodeFormatter	createCodeFormatter(java.util.Map options, int mode) Creates an instance of a code formatter.
static ClassFileBytesDisassembler	createDefaultClassFileBytesDisassembler() Create a classfile bytecode disassembler, able to produce a String representation of a given classfile.
static IClassFileDisassembler	createDefaultClassFileDisassembler() Deprecated. Use createDefaultClassFileBytesDisassembler() instead
static IClassFileReader	createDefaultClassFileReader(IClassFile classfile, int decodingFlag) Create a classfile reader onto a classfile Java element.
static IClassFileReader	createDefaultClassFileReader(java.io.InputStream stream, int decodingFlag) Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader.
static IClassFileReader	createDefaultClassFileReader(java.lang.String fileName, int decodingFlag) Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader.
static IClassFileReader	createDefaultClassFileReader(java.lang.String zipFileName, java.lang.String zipEntryName, int decodingFlag) Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader.
static ICodeFormatter	createDefaultCodeFormatter(java.util.Map options) Deprecated. Use createCodeFormatter(Map) instead but note the different options
static IScanner	createScanner(boolean tokenizeComments, boolean tokenizeWhiteSpace, boolean assertMode, boolean recordLineSeparator) Create a scanner, indicating the level of detail requested for tokenizing.
static IScanner	createScanner(boolean tokenizeComments, boolean tokenizeWhiteSpace, boolean recordLineSeparator, java.lang.String sourceLevel) Create a scanner, indicating the level of detail requested for tokenizing.
static IScanner	createScanner(boolean tokenizeComments, boolean tokenizeWhiteSpace, boolean recordLineSeparator, java.lang.String sourceLevel, java.lang.String complianceLevel) Create a scanner, indicating the level of detail requested for tokenizing.

Methods inherited from class java.lang.Object

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

Field Detail

M_FORMAT_NEW

public static final int M_FORMAT_NEW

This mode is used for formatting new code when some formatter options should not be used. In particular, options that preserve the indentation of comments are not used. In the future, newly added options may be ignored as well.

Clients that are formatting new code are recommended to use this mode.

Since:

3.3

See Also:

DefaultCodeFormatterConstants.FORMATTER_NEVER_INDENT_BLOCK_COMMENTS_ON_FIRST_COLUMN, DefaultCodeFormatterConstants.FORMATTER_NEVER_INDENT_LINE_COMMENTS_ON_FIRST_COLUMN, createCodeFormatter(Map, int)

M_FORMAT_EXISTING

public static final int M_FORMAT_EXISTING

This mode is used for formatting existing code when all formatter options should be used. In particular, options that preserve the indentation of comments are used.

Clients that are formatting existing code are recommended to use this mode.

Since:

3.3

See Also:

DefaultCodeFormatterConstants.FORMATTER_NEVER_INDENT_BLOCK_COMMENTS_ON_FIRST_COLUMN, DefaultCodeFormatterConstants.FORMATTER_NEVER_INDENT_LINE_COMMENTS_ON_FIRST_COLUMN, createCodeFormatter(Map, int)

Constructor Detail

ToolFactory

public ToolFactory()

Method Detail

createCodeFormatter

public static ICodeFormatter createCodeFormatter()

Deprecated. The extension point has been deprecated, use createCodeFormatter(Map) instead.

Create an instance of a code formatter. A code formatter implementation can be contributed via the extension point "org.aspectj.org.eclipse.jdt.core.codeFormatter". If unable to find a registered extension, the factory will default to using the default code formatter.

Returns:

an instance of a code formatter

See Also:

ICodeFormatter, createDefaultCodeFormatter(Map)

createCodeFormatter

public static CodeFormatter createCodeFormatter(java.util.Map options)

Create an instance of the built-in code formatter.

The given options should at least provide the source level (JavaCore.COMPILER_SOURCE), the compiler compliance level (JavaCore.COMPILER_COMPLIANCE) and the target platform (JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM). Without these options, it is not possible for the code formatter to know what kind of source it needs to format.

Note this is equivalent to createCodeFormatter(options, M_FORMAT_NEW). Thus some code formatter options may be ignored. See @{link M_FORMAT_NEW for more details.

Parameters:

options - - the options map to use for formatting with the default code formatter. Recognized options are documented on JavaCore#getDefaultOptions(). If set to null, then use the current settings from JavaCore#getOptions.

Returns:

an instance of the built-in code formatter

Since:

3.0

See Also:

CodeFormatter, JavaCore.getOptions()

createCodeFormatter

public static CodeFormatter createCodeFormatter(java.util.Map options,
                                                int mode)

Creates an instance of a code formatter. A code formatter implementation can be contributed via the extension point "org.aspectj.org.eclipse.jdt.core.javaFormatter". The formatter id specified in the "org.aspectj.org.eclipse.jdt.core.javaFormatter" is instantiated. If unable to find a registered extension, the factory will default to using the default code formatter.

The given options should at least provide the source level (JavaCore.COMPILER_SOURCE), the compiler compliance level (JavaCore.COMPILER_COMPLIANCE) and the target platform (JavaCore.COMPILER_CODEGEN_TARGET_PLATFORM). Without these options, it is not possible for the code formatter to know what kind of source it needs to format.

The given mode determines what options should be enabled when formatting the code. It can have the following values: M_FORMAT_NEW, M_FORMAT_EXISTING, but other values may be added in the future.

Parameters:

options - the options map to use for formatting with the default code formatter. Recognized options are documented on JavaCore#getDefaultOptions(). If set to null, then use the current settings from JavaCore#getOptions.

mode - the given mode to modify the given options.

Returns:

an instance of the built-in code formatter

Since:

3.3

See Also:

CodeFormatter, JavaCore.getOptions()

createDefaultClassFileBytesDisassembler

public static ClassFileBytesDisassembler createDefaultClassFileBytesDisassembler()

Create a classfile bytecode disassembler, able to produce a String representation of a given classfile.

Returns:

a classfile bytecode disassembler

Since:

2.1

See Also:

ClassFileBytesDisassembler

createDefaultClassFileDisassembler

public static IClassFileDisassembler createDefaultClassFileDisassembler()

Deprecated. Use createDefaultClassFileBytesDisassembler() instead

Create a classfile bytecode disassembler, able to produce a String representation of a given classfile.

Returns:

a classfile bytecode disassembler

See Also:

IClassFileDisassembler

createDefaultClassFileReader

public static IClassFileReader createDefaultClassFileReader(IClassFile classfile,
                                                            int decodingFlag)

Create a classfile reader onto a classfile Java element. Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader. Answer null if the file named fileName doesn't represent a valid .class file. The decoding flags are described in IClassFileReader.

Parameters:

classfile - the classfile element to introspect

decodingFlag - the flag used to decode the class file reader.

Returns:

a default classfile reader

See Also:

IClassFileReader

createDefaultClassFileReader

public static IClassFileReader createDefaultClassFileReader(java.io.InputStream stream,
                                                            int decodingFlag)

Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader. Answer null if the input stream contents cannot be retrieved The decoding flags are described in IClassFileReader.

Parameters:

stream - the given input stream to read

decodingFlag - the flag used to decode the class file reader.

Returns:

a default classfile reader

Since:

3.2

See Also:

IClassFileReader

createDefaultClassFileReader

public static IClassFileReader createDefaultClassFileReader(java.lang.String fileName,
                                                            int decodingFlag)

Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader. Answer null if the file named fileName doesn't represent a valid .class file. The fileName has to be an absolute OS path to the given .class file. The decoding flags are described in IClassFileReader.

Parameters:

fileName - the name of the file to be read

decodingFlag - the flag used to decode the class file reader.

Returns:

a default classfile reader

See Also:

IClassFileReader

createDefaultClassFileReader

public static IClassFileReader createDefaultClassFileReader(java.lang.String zipFileName,
                                                            java.lang.String zipEntryName,
                                                            int decodingFlag)

Create a default classfile reader, able to expose the internal representation of a given classfile according to the decoding flag used to initialize the reader. Answer null if the file named zipFileName doesn't represent a valid zip file or if the zipEntryName is not a valid entry name for the specified zip file or if the bytes don't represent a valid .class file according to the JVM specifications. The decoding flags are described in IClassFileReader.

Parameters:

zipFileName - the name of the zip file

zipEntryName - the name of the entry in the zip file to be read

decodingFlag - the flag used to decode the class file reader.

Returns:

a default classfile reader

See Also:

IClassFileReader

createDefaultCodeFormatter

public static ICodeFormatter createDefaultCodeFormatter(java.util.Map options)

Deprecated. Use createCodeFormatter(Map) instead but note the different options

Create an instance of the default code formatter.

Parameters:

options - - the options map to use for formatting with the default code formatter. Recognized options are documented on JavaCore#getDefaultOptions(). If set to null, then use the current settings from JavaCore#getOptions.

Returns:

an instance of the built-in code formatter

See Also:

ICodeFormatter, createCodeFormatter(), JavaCore.getOptions()

createScanner

public static IScanner createScanner(boolean tokenizeComments,
                                     boolean tokenizeWhiteSpace,
                                     boolean assertMode,
                                     boolean recordLineSeparator)

Create a scanner, indicating the level of detail requested for tokenizing. The scanner can then be used to tokenize some source in a Java aware way. Here is a typical scanning loop:

   IScanner scanner = ToolFactory.createScanner(false, false, false, false);
   scanner.setSource("int i = 0;".toCharArray());
   while (true) {
     int token = scanner.getNextToken();
     if (token == ITerminalSymbols.TokenNameEOF) break;
     System.out.println(token + " : " + new String(scanner.getCurrentTokenSource()));
   }
 

By default the compliance used to create the scanner is the workspace's compliance when running inside the IDE or 1.4 if running from outside of a headless eclipse.

Parameters:

tokenizeComments - if set to false, comments will be silently consumed

tokenizeWhiteSpace - if set to false, white spaces will be silently consumed,

assertMode - if set to false, occurrences of 'assert' will be reported as identifiers (ITerminalSymbols.TokenNameIdentifier), whereas if set to true, it would report assert keywords (ITerminalSymbols.TokenNameassert). Java 1.4 has introduced a new 'assert' keyword.

recordLineSeparator - if set to true, the scanner will record positions of encountered line separator ends. In case of multi-character line separators, the last character position is considered. These positions can then be extracted using IScanner.getLineEnds(). Only non-unicode escape sequences are considered as valid line separators.

Returns:

a scanner

See Also:

IScanner, createScanner(boolean, boolean, boolean, String, String)

createScanner

public static IScanner createScanner(boolean tokenizeComments,
                                     boolean tokenizeWhiteSpace,
                                     boolean recordLineSeparator,
                                     java.lang.String sourceLevel)

Create a scanner, indicating the level of detail requested for tokenizing. The scanner can then be used to tokenize some source in a Java aware way. Here is a typical scanning loop:

   IScanner scanner = ToolFactory.createScanner(false, false, false, false);
   scanner.setSource("int i = 0;".toCharArray());
   while (true) {
     int token = scanner.getNextToken();
     if (token == ITerminalSymbols.TokenNameEOF) break;
     System.out.println(token + " : " + new String(scanner.getCurrentTokenSource()));
   }
 

By default the compliance used to create the scanner is the workspace's compliance when running inside the IDE or 1.4 if running from outside of a headless eclipse.

Parameters:

tokenizeComments - if set to false, comments will be silently consumed

tokenizeWhiteSpace - if set to false, white spaces will be silently consumed,

recordLineSeparator - if set to true, the scanner will record positions of encountered line separator ends. In case of multi-character line separators, the last character position is considered. These positions can then be extracted using IScanner.getLineEnds(). Only non-unicode escape sequences are considered as valid line separators.

sourceLevel - if set to "1.3" or null, occurrences of 'assert' will be reported as identifiers (ITerminalSymbols.TokenNameIdentifier), whereas if set to "1.4", it would report assert keywords (ITerminalSymbols.TokenNameassert). Java 1.4 has introduced a new 'assert' keyword.

Returns:

a scanner

Since:

3.0

See Also:

IScanner, createScanner(boolean, boolean, boolean, String, String)

createScanner

public static IScanner createScanner(boolean tokenizeComments,
                                     boolean tokenizeWhiteSpace,
                                     boolean recordLineSeparator,
                                     java.lang.String sourceLevel,
                                     java.lang.String complianceLevel)

Create a scanner, indicating the level of detail requested for tokenizing. The scanner can then be used to tokenize some source in a Java aware way. Here is a typical scanning loop:

   IScanner scanner = ToolFactory.createScanner(false, false, false, false);
   scanner.setSource("int i = 0;".toCharArray());
   while (true) {
     int token = scanner.getNextToken();
     if (token == ITerminalSymbols.TokenNameEOF) break;
     System.out.println(token + " : " + new String(scanner.getCurrentTokenSource()));
   }
 

Parameters:

tokenizeComments - if set to false, comments will be silently consumed

tokenizeWhiteSpace - if set to false, white spaces will be silently consumed,

recordLineSeparator - if set to true, the scanner will record positions of encountered line separator ends. In case of multi-character line separators, the last character position is considered. These positions can then be extracted using IScanner.getLineEnds(). Only non-unicode escape sequences are considered as valid line separators.

sourceLevel - if set to "1.3" or null, occurrences of 'assert' will be reported as identifiers (ITerminalSymbols.TokenNameIdentifier), whereas if set to "1.4", it would report assert keywords (ITerminalSymbols.TokenNameassert). Java 1.4 has introduced a new 'assert' keyword.

complianceLevel - This is used to support the Unicode 4.0 character sets. if set to 1.5 or above, the Unicode 4.0 is supported, otherwise Unicode 3.0 is supported.

Returns:

a scanner

Since:

3.1

See Also:

IScanner