org.eclipse.jdt.internal.formatter.old
Class CodeFormatter

java.lang.Object
  org.eclipse.jdt.internal.formatter.old.CodeFormatter

All Implemented Interfaces:

ICodeFormatter, TerminalTokens

Deprecated.

public class CodeFormatter
extends java.lang.Object
implements TerminalTokens, ICodeFormatter

How to format a piece of code ?

• Create an instance of CodeFormatter
• Use the method void format(aString) on this instance to format aString. It will return the formatted string.

Field Summary

Fields inherited from interface org.eclipse.jdt.internal.compiler.parser.TerminalTokens

TokenNameabstract, TokenNameAND, TokenNameAND_AND, TokenNameAND_EQUAL, TokenNameassert, TokenNameAT, TokenNameboolean, TokenNamebreak, TokenNamebyte, TokenNamecase, TokenNamecatch, TokenNamechar, TokenNameCharacterLiteral, TokenNameclass, TokenNameCOLON, TokenNameCOMMA, TokenNameCOMMENT_BLOCK, TokenNameCOMMENT_JAVADOC, TokenNameCOMMENT_LINE, TokenNameconst, TokenNamecontinue, TokenNamedefault, TokenNameDIVIDE, TokenNameDIVIDE_EQUAL, TokenNamedo, TokenNameDOT, TokenNamedouble, TokenNameDoubleLiteral, TokenNameELLIPSIS, TokenNameelse, TokenNameenum, TokenNameEOF, TokenNameEQUAL, TokenNameEQUAL_EQUAL, TokenNameERROR, TokenNameextends, TokenNamefalse, TokenNamefinal, TokenNamefinally, TokenNamefloat, TokenNameFloatingPointLiteral, TokenNamefor, TokenNamegoto, TokenNameGREATER, TokenNameGREATER_EQUAL, TokenNameIdentifier, TokenNameif, TokenNameimplements, TokenNameimport, TokenNameinstanceof, TokenNameint, TokenNameIntegerLiteral, TokenNameinterface, TokenNameLBRACE, TokenNameLBRACKET, TokenNameLEFT_SHIFT, TokenNameLEFT_SHIFT_EQUAL, TokenNameLESS, TokenNameLESS_EQUAL, TokenNamelong, TokenNameLongLiteral, TokenNameLPAREN, TokenNameMINUS, TokenNameMINUS_EQUAL, TokenNameMINUS_MINUS, TokenNameMULTIPLY, TokenNameMULTIPLY_EQUAL, TokenNamenative, TokenNamenew, TokenNameNOT, TokenNameNOT_EQUAL, TokenNamenull, TokenNameOR, TokenNameOR_EQUAL, TokenNameOR_OR, TokenNamepackage, TokenNamePLUS, TokenNamePLUS_EQUAL, TokenNamePLUS_PLUS, TokenNameprivate, TokenNameprotected, TokenNamepublic, TokenNameQUESTION, TokenNameRBRACE, TokenNameRBRACKET, TokenNameREMAINDER, TokenNameREMAINDER_EQUAL, TokenNamereturn, TokenNameRIGHT_SHIFT, TokenNameRIGHT_SHIFT_EQUAL, TokenNameRPAREN, TokenNameSEMICOLON, TokenNameshort, TokenNamestatic, TokenNamestrictfp, TokenNameStringLiteral, TokenNamesuper, TokenNameswitch, TokenNamesynchronized, TokenNamethis, TokenNamethrow, TokenNamethrows, TokenNametransient, TokenNametrue, TokenNametry, TokenNameTWIDDLE, TokenNameUNSIGNED_RIGHT_SHIFT, TokenNameUNSIGNED_RIGHT_SHIFT_EQUAL, TokenNamevoid, TokenNamevolatile, TokenNamewhile, TokenNameWHITESPACE, TokenNameXOR, TokenNameXOR_EQUAL

Constructor Summary

CodeFormatter(java.util.Map options)
Deprecated.

Method Summary

java.lang.String

format(java.lang.String string, int indentLevel, int[] positions, java.lang.String lineSeparator) Deprecated. Formats the String sourceString, and returns a string containing the formatted version.

Methods inherited from class java.lang.Object

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

Constructor Detail

CodeFormatter

public CodeFormatter(java.util.Map options)

Deprecated.

Method Detail

format

public java.lang.String format(java.lang.String string,
                               int indentLevel,
                               int[] positions,
                               java.lang.String lineSeparator)

Deprecated.

Description copied from interface: ICodeFormatter

Formats the String sourceString, and returns a string containing the formatted version.

Specified by:

format in interface ICodeFormatter

Parameters:

string - the string to format

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

positions - an array of positions to map. These are character-based source positions inside the original source, arranged in non-decreasing order, for which corresponding positions in the formatted source will be computed (so as to relocate elements associated with the original source). It updates the positions array with updated positions. If set to null, then no positions are mapped.

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

Returns:

the formatted output string.