oracle.javatools.parser.java.v2.util

Class Formatting

java.lang.Object

oracle.javatools.parser.java.v2.util.Formatting

public class Formatting
extends java.lang.Object

Utility class for use in formatting a SourceFile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Formatting.Selection

Method Summary

Modifier and Type	Method and Description
static Formatting.Selection	reformatRegion(SourceFile file, int startOffset, int endOffset) Attempts to reformat between the (inclusive) input Textbuffer offsets.
static javax.swing.undo.UndoableEdit	reformatSelection(SourceFile file, int start, int end) This method reformats the selected region of code.
static boolean	reformatSubtree(SourceElement subtree) Attempts to reformat the given subtree.

Methods inherited from class java.lang.Object

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

Method Detail

reformatRegion

public static Formatting.Selection reformatRegion(SourceFile file,
                                                  int startOffset,
                                                  int endOffset)

Attempts to reformat between the (inclusive) input Textbuffer offsets. If a write operation is not permitted, an exception is thrown.

Returns:

If this reformat operation was successful, then the offsets defining the dirty region are returned via the Selection class. If the operation was not successful, null is returned.

reformatSubtree

public static boolean reformatSubtree(SourceElement subtree)

Attempts to reformat the given subtree. If a write operation is not permitted, an exception is thrown.

Parameters:

subtree - The SourceElement whose contents should be formatted.

Returns:

True if the reformat succeeded, false otherwise (usually due to syntax errors in the source which prohibit reformats)

reformatSelection

public static javax.swing.undo.UndoableEdit reformatSelection(SourceFile file,
                                                              int start,
                                                              int end)

This method reformats the selected region of code.

Parameters:

file - is the source file that contains the selection region

start - is the start offset of the selected region

end - is the end offset of the selected region

Returns:

The undoable edit for this reformat, which might be null if the reformat failed