org.apache.bsf.util.cf
Class CodeFormatter
java.lang.Object
org.apache.bsf.util.cf.CodeFormatter
public class CodeFormatter
extends java.lang.Object
A 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.
- Matthew J. Duftler
void | formatCode(Reader source, Writer target) - Formats the code read from
source , and writes the formatted
code to target .
|
String | getDelimiters() - Gets the set of delimiters.
|
int | getIndentationStep() - Gets the size of the indentation step.
|
int | getMaxLineLength() - Gets the maximum line length.
|
String | getStickyDelimiters() - 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 is
2 .
|
void | setMaxLineLength(int newMaxLineLength) - Sets the (desired) maximum line length; default length is
74 .
|
void | setStickyDelimiters(String newStickyDelimiters) - Sets the set of sticky delimiters; default set is
"," .
|
DEFAULT_DELIM
public static final String DEFAULT_DELIM
The default set of delimiters.
DEFAULT_MAX
public static final int DEFAULT_MAX
The default maximum line length.
- 74
DEFAULT_STEP
public static final int DEFAULT_STEP
The default size of the indentation step.
- 2
DEFAULT_S_DELIM
public static final String DEFAULT_S_DELIM
The default set of sticky delimiters.
formatCode
public void formatCode(Reader source,
Writer target)
Formats the code read from source
, and writes the formatted
code to target
.
source
- where to read the unformatted code from.target
- where to write the formatted code to.
getDelimiters
public String getDelimiters()
Gets the set of delimiters.
- the set of delimiters.
setDelimiters(String)
getIndentationStep
public int getIndentationStep()
Gets the size of the indentation step.
- the size of the indentation step.
setIndentationStep(int)
getMaxLineLength
public int getMaxLineLength()
Gets the maximum line length.
- the maximum line length.
setMaxLineLength(int)
getStickyDelimiters
public String getStickyDelimiters()
Gets the set of sticky delimiters.
- the set of sticky delimiters.
setStickyDelimiters(String)
setDelimiters
public void setDelimiters(String newDelimiters)
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.
newDelimiters
- the new set of delimiters.
getDelimiters()
setIndentationStep
public void setIndentationStep(int newIndentationStep)
Sets the size of the indentation step; default size is
2
.
This is the number of spaces that lines will be indented (when appropriate).
newIndentationStep
- the new size of the indentation step.
getIndentationStep()
setMaxLineLength
public void setMaxLineLength(int newMaxLineLength)
Sets the (desired) maximum line length; default length is
74
.
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.
newMaxLineLength
- the new maximum line length.
getMaxLineLength()
setStickyDelimiters
public void setStickyDelimiters(String newStickyDelimiters)
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.
newStickyDelimiters
- the new set of sticky delimiters.
getStickyDelimiters()