Class ASTRewriteFormatter

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.dom.rewrite.ASTRewriteFormatter

public final class ASTRewriteFormatter
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ASTRewriteFormatter.BlockContext
static class	ASTRewriteFormatter.ConstPrefix
static class	ASTRewriteFormatter.NodeMarker
static interface	ASTRewriteFormatter.Prefix

Field Summary

Fields

Modifier and Type	Field	Description
final ASTRewriteFormatter.Prefix	ANNOT_MEMBER_DEFAULT
final ASTRewriteFormatter.Prefix	ANNOTATION_SEPARATION
static final ASTRewriteFormatter.Prefix	ASSERT_COMMENT
final ASTRewriteFormatter.Prefix	CASE_SEPARATION
final ASTRewriteFormatter.Prefix	CATCH_BLOCK
final ASTRewriteFormatter.BlockContext	DO_BLOCK
final ASTRewriteFormatter.BlockContext	ELSE_AFTER_BLOCK
final ASTRewriteFormatter.BlockContext	ELSE_AFTER_STATEMENT
final ASTRewriteFormatter.Prefix	ENUM_BODY_END
final ASTRewriteFormatter.Prefix	ENUM_BODY_START
final ASTRewriteFormatter.Prefix	FINALLY_BLOCK
final ASTRewriteFormatter.Prefix	FIRST_ENUM_CONST
final ASTRewriteFormatter.BlockContext	FOR_BLOCK
final ASTRewriteFormatter.BlockContext	IF_BLOCK_NO_ELSE
final ASTRewriteFormatter.BlockContext	IF_BLOCK_WITH_ELSE
final ASTRewriteFormatter.Prefix	LOCAL_ANNOTATION_SEPARATION
final ASTRewriteFormatter.Prefix	METHOD_BODY
static final ASTRewriteFormatter.Prefix	NONE
final ASTRewriteFormatter.Prefix	PARAM_ANNOTATION_SEPARATION
static final ASTRewriteFormatter.Prefix	SPACE
final ASTRewriteFormatter.Prefix	TRY_RESOURCES
final ASTRewriteFormatter.Prefix	TRY_RESOURCES_PAREN
final ASTRewriteFormatter.Prefix	TYPE_ANNOTATION_SEPARATION
final ASTRewriteFormatter.Prefix	VAR_INITIALIZER
final ASTRewriteFormatter.Prefix	VARARGS
final ASTRewriteFormatter.BlockContext	WHILE_BLOCK
final ASTRewriteFormatter.Prefix	WILDCARD_EXTENDS
final ASTRewriteFormatter.Prefix	WILDCARD_SUPER

Constructor Summary

Constructors

Constructor	Description
ASTRewriteFormatter(NodeInfoStore placeholders, RewriteEventStore eventStore, Map options, String lineDelimiter)

Method Summary

Modifier and Type	Method	Description
String	changeIndent(String code, int codeIndentLevel, String newIndent)
int	computeIndentInSpaces(String line)
int	computeIndentUnits(String line)
String	createIndentString(int indentationUnits)
String	createIndentString(int indentationUnits, int minimumIndentInSpaces)
static String	evaluateFormatterEdit(String string, org.eclipse.text.edits.TextEdit edit, org.eclipse.jface.text.Position[] positions)	Evaluates the edit on the given string.
org.eclipse.text.edits.TextEdit	formatString(int kind, String string, int offset, int length, int indentationLevel)
RewriteEventStore	getEventStore()
String	getFormattedResult(ASTNode node, int initialIndentationLevel, int minimumIndentInSpaces, Collection resultingMarkers)	Returns the string accumulated in the visit formatted using the default formatter.
String	getIndentString(String currentLine)
String	getIndentStringWithSpaces(String currentLine)
int	getIndentWidth()
String	getLineDelimiter()
NodeInfoStore	getPlaceholders()
int	getTabWidth()

Methods inherited from class java.lang.Object

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

Field Details

NONE

public static final ASTRewriteFormatter.Prefix NONE

SPACE

public static final ASTRewriteFormatter.Prefix SPACE

ASSERT_COMMENT

public static final ASTRewriteFormatter.Prefix ASSERT_COMMENT

VAR_INITIALIZER

public final ASTRewriteFormatter.Prefix VAR_INITIALIZER

METHOD_BODY

public final ASTRewriteFormatter.Prefix METHOD_BODY

FINALLY_BLOCK

public final ASTRewriteFormatter.Prefix FINALLY_BLOCK

CATCH_BLOCK

public final ASTRewriteFormatter.Prefix CATCH_BLOCK

ANNOT_MEMBER_DEFAULT

public final ASTRewriteFormatter.Prefix ANNOT_MEMBER_DEFAULT

ENUM_BODY_START

public final ASTRewriteFormatter.Prefix ENUM_BODY_START

ENUM_BODY_END

public final ASTRewriteFormatter.Prefix ENUM_BODY_END

WILDCARD_EXTENDS

public final ASTRewriteFormatter.Prefix WILDCARD_EXTENDS

WILDCARD_SUPER

public final ASTRewriteFormatter.Prefix WILDCARD_SUPER

FIRST_ENUM_CONST

public final ASTRewriteFormatter.Prefix FIRST_ENUM_CONST

ANNOTATION_SEPARATION

public final ASTRewriteFormatter.Prefix ANNOTATION_SEPARATION

PARAM_ANNOTATION_SEPARATION

public final ASTRewriteFormatter.Prefix PARAM_ANNOTATION_SEPARATION

LOCAL_ANNOTATION_SEPARATION

public final ASTRewriteFormatter.Prefix LOCAL_ANNOTATION_SEPARATION

TYPE_ANNOTATION_SEPARATION

public final ASTRewriteFormatter.Prefix TYPE_ANNOTATION_SEPARATION

VARARGS

public final ASTRewriteFormatter.Prefix VARARGS

TRY_RESOURCES

public final ASTRewriteFormatter.Prefix TRY_RESOURCES

TRY_RESOURCES_PAREN

public final ASTRewriteFormatter.Prefix TRY_RESOURCES_PAREN

IF_BLOCK_WITH_ELSE

public final ASTRewriteFormatter.BlockContext IF_BLOCK_WITH_ELSE

IF_BLOCK_NO_ELSE

public final ASTRewriteFormatter.BlockContext IF_BLOCK_NO_ELSE

ELSE_AFTER_STATEMENT

public final ASTRewriteFormatter.BlockContext ELSE_AFTER_STATEMENT

ELSE_AFTER_BLOCK

public final ASTRewriteFormatter.BlockContext ELSE_AFTER_BLOCK

CASE_SEPARATION

public final ASTRewriteFormatter.Prefix CASE_SEPARATION

FOR_BLOCK

public final ASTRewriteFormatter.BlockContext FOR_BLOCK

WHILE_BLOCK

public final ASTRewriteFormatter.BlockContext WHILE_BLOCK

DO_BLOCK

public final ASTRewriteFormatter.BlockContext DO_BLOCK

Constructor Details

ASTRewriteFormatter

public ASTRewriteFormatter(NodeInfoStore placeholders,
 RewriteEventStore eventStore,
 Map options,
 String lineDelimiter)

Method Details

getPlaceholders

public NodeInfoStore getPlaceholders()

getEventStore

public RewriteEventStore getEventStore()

getTabWidth

public int getTabWidth()

getIndentWidth

public int getIndentWidth()

getLineDelimiter

public String getLineDelimiter()

getFormattedResult

public String getFormattedResult(ASTNode node,
 int initialIndentationLevel,
 int minimumIndentInSpaces,
 Collection resultingMarkers)

Returns the string accumulated in the visit formatted using the default formatter. Updates the existing node's positions.

Parameters:

node - The node to flatten.

initialIndentationLevel - The initial indentation level.

minimumIndentInSpaces - The minimum indent to use in spaces

resultingMarkers - Resulting the updated NodeMarkers.

Returns:

Returns the serialized and formatted code.

createIndentString

public String createIndentString(int indentationUnits)

createIndentString

public String createIndentString(int indentationUnits,
 int minimumIndentInSpaces)

getIndentString

public String getIndentString(String currentLine)

getIndentStringWithSpaces

public String getIndentStringWithSpaces(String currentLine)

changeIndent

public String changeIndent(String code,
 int codeIndentLevel,
 String newIndent)

computeIndentUnits

public int computeIndentUnits(String line)

computeIndentInSpaces

public int computeIndentInSpaces(String line)

evaluateFormatterEdit

public static String evaluateFormatterEdit(String string,
 org.eclipse.text.edits.TextEdit edit,
 org.eclipse.jface.text.Position[] positions)

Evaluates the edit on the given string.

Parameters:

string - The string to format

edit - The edit resulted from the code formatter

positions - Positions to update or null.

Returns:

The formatted string

Throws:

IllegalArgumentException - If the positions are not inside the string, a IllegalArgumentException is thrown.

formatString

public org.eclipse.text.edits.TextEdit formatString(int kind,
 String string,
 int offset,
 int length,
 int indentationLevel)