Class CodeFormatter
CodeFormatter
bean is used to format raw Java code. It
indents, word-wraps, and replaces tab characters with an amount of space
characters equal to the size of the indentationStep
property.
To create and use a CodeFormatter
, you simply instantiate a
new CodeFormatter
bean, and invoke
formatCode(Reader source, Writer target)
with appropriate
arguments.- Author:
- Matthew J. Duftler
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
formatCode
(Reader source, Writer target) Formats the code read fromsource
, and writes the formatted code totarget
.Gets the set of delimiters.int
Gets the size of the indentation step.int
Gets the maximum line length.Gets the set of sticky delimiters.void
setDelimiters
(String newDelimiters) Sets the set of delimiters; default set is"(+"
.void
setIndentationStep
(int newIndentationStep) Sets the size of the indentation step; default size is2
.void
setMaxLineLength
(int newMaxLineLength) Sets the (desired) maximum line length; default length is74
.void
setStickyDelimiters
(String newStickyDelimiters) Sets the set of sticky delimiters; default set is","
.
-
Field Details
-
DEFAULT_MAX
public static final int DEFAULT_MAXThe default maximum line length.- See Also:
-
DEFAULT_STEP
public static final int DEFAULT_STEPThe default size of the indentation step.- See Also:
-
DEFAULT_DELIM
The default set of delimiters.- See Also:
-
DEFAULT_S_DELIM
The default set of sticky delimiters.- See Also:
-
-
Constructor Details
-
CodeFormatter
public CodeFormatter()
-
-
Method Details
-
formatCode
Formats the code read fromsource
, and writes the formatted code totarget
.- Parameters:
source
- where to read the unformatted code from.target
- where to write the formatted code to.
-
getDelimiters
Gets the set of delimiters.- Returns:
- the set of delimiters.
- See Also:
-
getIndentationStep
public int getIndentationStep()Gets the size of the indentation step.- Returns:
- the size of the indentation step.
- See Also:
-
getMaxLineLength
public int getMaxLineLength()Gets the maximum line length.- Returns:
- the maximum line length.
- See Also:
-
getStickyDelimiters
Gets the set of sticky delimiters.- Returns:
- the set of sticky delimiters.
- See Also:
-
setDelimiters
Sets the set of delimiters; default set is"(+"
.Each character represents one delimiter. If a line is ready to be word-wrapped and a delimiter is encountered, the delimiter will appear as the first character on the following line. A quotation mark,
"
or'
, opening a string is always a delimiter, whether you specify it or not.- Parameters:
newDelimiters
- the new set of delimiters.- See Also:
-
setIndentationStep
public void setIndentationStep(int newIndentationStep) Sets the size of the indentation step; default size is2
.This is the number of spaces that lines will be indented (when appropriate).
- Parameters:
newIndentationStep
- the new size of the indentation step.- See Also:
-
setMaxLineLength
public void setMaxLineLength(int newMaxLineLength) Sets the (desired) maximum line length; default length is74
.If a token is longer than the requested maximum line length, then the line containing that token will obviously be longer than the desired maximum.
- Parameters:
newMaxLineLength
- the new maximum line length.- See Also:
-
setStickyDelimiters
Sets the set of sticky delimiters; default set is","
.Each character represents one sticky delimiter. If a line is ready to be word-wrapped and a sticky delimiter is encountered, the sticky delimiter will appear as the last character on the current line. A quotation mark,
"
or'
, closing a string is always a sticky delimiter, whether you specify it or not.- Parameters:
newStickyDelimiters
- the new set of sticky delimiters.- See Also:
-