org.aspectj.org.eclipse.jdt.internal.formatter

Class DefaultCodeFormatter

java.lang.Object

org.aspectj.org.eclipse.jdt.core.formatter.CodeFormatter

org.aspectj.org.eclipse.jdt.internal.formatter.DefaultCodeFormatter

public class DefaultCodeFormatter
extends CodeFormatter

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEBUG Debug trace
boolean	previewEnabled

Fields inherited from class org.aspectj.org.eclipse.jdt.core.formatter.CodeFormatter

F_INCLUDE_COMMENTS, K_CLASS_BODY_DECLARATIONS, K_COMPILATION_UNIT, K_EXPRESSION, K_JAVA_DOC, K_MODULE_INFO, K_MULTI_LINE_COMMENT, K_SINGLE_LINE_COMMENT, K_STATEMENTS, K_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
DefaultCodeFormatter()
DefaultCodeFormatter(DefaultCodeFormatterOptions options)
DefaultCodeFormatter(DefaultCodeFormatterOptions defaultCodeFormatterOptions, java.util.Map<java.lang.String,java.lang.String> options)
DefaultCodeFormatter(java.util.Map<java.lang.String,java.lang.String> options)

Method Summary

Modifier and Type	Method and Description
java.lang.String	createIndentationString(int indentationLevel) Answers the string that corresponds to the indentation to the given indentation level or an empty string if the indentation cannot be computed.
TextEdit	format(int kind, java.lang.String source, int offset, int length, int indentationLevel, java.lang.String lineSeparator) Format source, and returns a text edit that correspond to the difference between the given string and the formatted string.
TextEdit	format(int kind, java.lang.String source, IRegion[] regions, int indentationLevel, java.lang.String lineSeparator) Format source, and returns a text edit that correspond to the difference between the given string and the formatted string.
void	setOptions(java.util.Map<java.lang.String,java.lang.String> options) Sets the formatting options for this formatter.

Methods inherited from class java.lang.Object

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

Field Detail

DEBUG

public static boolean DEBUG

Debug trace

previewEnabled

public boolean previewEnabled

Constructor Detail

DefaultCodeFormatter

public DefaultCodeFormatter()

DefaultCodeFormatter

public DefaultCodeFormatter(DefaultCodeFormatterOptions options)

DefaultCodeFormatter

public DefaultCodeFormatter(java.util.Map<java.lang.String,java.lang.String> options)

DefaultCodeFormatter

public DefaultCodeFormatter(DefaultCodeFormatterOptions defaultCodeFormatterOptions,
                            java.util.Map<java.lang.String,java.lang.String> options)

Method Detail

createIndentationString

public java.lang.String createIndentationString(int indentationLevel)

Description copied from class: CodeFormatter

Answers the string that corresponds to the indentation to the given indentation level or an empty string if the indentation cannot be computed.

This method needs to be overridden in a subclass.

The default implementation returns an empty string.

Overrides:

createIndentationString in class CodeFormatter

Parameters:

indentationLevel - the given indentation level

Returns:

the string corresponding to the right indentation level

format

public TextEdit format(int kind,
                       java.lang.String source,
                       int offset,
                       int length,
                       int indentationLevel,
                       java.lang.String lineSeparator)

Description copied from class: CodeFormatter

Format source, and returns a text edit that correspond to the difference between the given string and the formatted string.

It returns null if the given string cannot be formatted.

If the offset position is matching a whitespace, the result can include whitespaces. It would be up to the caller to get rid of preceding whitespaces.

Specified by:

format in class CodeFormatter

Parameters:

kind - Use to specify the kind of the code snippet to format. It can be any of these:

• CodeFormatter.K_EXPRESSION
• CodeFormatter.K_STATEMENTS
• CodeFormatter.K_CLASS_BODY_DECLARATIONS
• CodeFormatter.K_COMPILATION_UNIT
• CodeFormatter.K_MODULE_INFO
• CodeFormatter.K_UNKNOWN
• CodeFormatter.K_SINGLE_LINE_COMMENT
• CodeFormatter.K_MULTI_LINE_COMMENT
• CodeFormatter.K_JAVA_DOC

Since 3.4 for CodeFormatter.K_COMPILATION_UNIT and since 3.6 for other kinds unrelated to comments, the CodeFormatter.F_INCLUDE_COMMENTS flag can be used to format comments on the fly (see the flag documentation for more detailed explanation).

source - the source to format

offset - the given offset to start recording the edits (inclusive).

length - the given length to stop recording the edits (exclusive).

indentationLevel - the initial indentation level, used to shift left/right the entire source fragment. An initial indentation level of zero or below has no effect.

lineSeparator - the line separator to use in formatted source, if set to null, then the platform default one will be used.

Returns:

the text edit

See Also:

CodeFormatter.format(int, java.lang.String, int, int, int, java.lang.String)

format

public TextEdit format(int kind,
                       java.lang.String source,
                       IRegion[] regions,
                       int indentationLevel,
                       java.lang.String lineSeparator)

Format source, and returns a text edit that correspond to the difference between the given string and the formatted string.

It returns null if the given string cannot be formatted.

If an offset position is matching a whitespace, the result can include whitespaces. It would be up to the caller to get rid of preceding whitespaces.

No region in regions must overlap with any other region in regions. Each region must be within source. There must be at least one region. Regions must be sorted by their offsets, smaller offset first.

Specified by:

format in class CodeFormatter

Parameters:

kind - Use to specify the kind of the code snippet to format. It can be any of these:

• CodeFormatter.K_EXPRESSION
• CodeFormatter.K_STATEMENTS
• CodeFormatter.K_CLASS_BODY_DECLARATIONS
• CodeFormatter.K_COMPILATION_UNIT
• CodeFormatter.K_MODULE_INFO
• CodeFormatter.K_UNKNOWN
• CodeFormatter.K_SINGLE_LINE_COMMENT
• CodeFormatter.K_MULTI_LINE_COMMENT
• CodeFormatter.K_JAVA_DOC

Since 3.4 for CodeFormatter.K_COMPILATION_UNIT and since 3.6 for other kinds unrelated to comments, the CodeFormatter.F_INCLUDE_COMMENTS flag can be used to format comments on the fly (see the flag documentation for more detailed explanation).

source - the source to format

regions - a set of regions in source to format

indentationLevel - the initial indentation level, used to shift left/right the entire source fragment. An initial indentation level of zero or below has no effect.

lineSeparator - the line separator to use in formatted source, if set to null, then the platform default one will be used.

Returns:

the text edit

setOptions

public void setOptions(java.util.Map<java.lang.String,java.lang.String> options)

Description copied from class: CodeFormatter

Sets the formatting options for this formatter.

The default implementation ignores the options.

Overrides:

setOptions in class CodeFormatter

Parameters:

options - the options for the formatter