org.apache.tools.ant.filters
public final class FixCrLfFilter extends BaseParamFilterReader implements ChainableReader
This filter can take the following arguments:
This version generalises the handling of EOL characters, and allows for CR-only line endings (the standard on Mac systems prior to OS X). Tab handling has also been generalised to accommodate any tabwidth from 2 to 80, inclusive. Importantly, it can leave untouched any literal TAB characters embedded within Java string or character constants.
Caution: run with care on carefully formatted files. This may sound obvious, but if you don't specify asis, presume that your files are going to be modified. If "tabs" is "add" or "remove", whitespace characters may be added or removed as necessary. Similarly, for EOLs, eol="asis" actually means convert to your native O/S EOL convention while eol="crlf" or cr="add" can result in CR characters being removed in one special case accommodated, i.e., CRCRLF is regarded as a single EOL to handle cases where other programs have converted CRLF into CRCRLF.
Example:
<<fixcrlf tab="add" eol="crlf" eof="asis"/>Or:
<filterreader classname="org.apache.tools.ant.filters.FixCrLfFilter"> <param eol="crlf" tab="asis"/> </filterreader>
Nested Class Summary | |
---|---|
static class | FixCrLfFilter.AddAsisRemove
Enumerated attribute with the values "asis", "add" and "remove". |
static class | FixCrLfFilter.CrLf
Enumerated attribute with the values "asis", "cr", "lf" and "crlf". |
Constructor Summary | |
---|---|
FixCrLfFilter()
Constructor for "dummy" instances.
| |
FixCrLfFilter(Reader in)
Create a new filtered reader.
|
Method Summary | |
---|---|
Reader | chain(Reader rdr)
Create a new FixCrLfFilter using the passed in Reader for instantiation.
|
FixCrLfFilter.AddAsisRemove | getEof()
Get how DOS EOF (control-z) characters are being handled.
|
FixCrLfFilter.CrLf | getEol()
Get how EndOfLine characters are being handled.
|
boolean | getFixlast()
Get whether a missing EOL be added to the final line of the stream.
|
boolean | getJavafiles()
Get whether the stream is to be treated as though it contains Java
source.
|
FixCrLfFilter.AddAsisRemove | getTab()
Return how tab characters are being handled.
|
int | getTablength()
Get the tab length to use.
|
int | read()
Return the next character in the filtered stream.
|
void | setEof(FixCrLfFilter.AddAsisRemove attr)
Specify how DOS EOF (control-z) characters are to be handled.
|
void | setEol(FixCrLfFilter.CrLf attr)
Specify how end of line (EOL) characters are to be handled.
|
void | setFixlast(boolean fixlast)
Specify whether a missing EOL will be added to the final line of input.
|
void | setJavafiles(boolean javafiles)
Indicate whether this stream contains Java source.
|
void | setTab(FixCrLfFilter.AddAsisRemove attr)
Specify how tab characters are to be handled.
|
void | setTablength(int tabLength)
Specify tab length in characters.
|
See Also: BaseFilterReader
Parameters: in
A Reader object providing the underlying stream. Must not be
null
.
Throws: IOException on error.
Parameters: rdr
A Reader object providing the underlying stream. Must not be
null
.
Returns: a new filter based on this configuration, but filtering the specified reader.
Returns: values:
Returns: values:
Returns: true if a filtered file will always end with an EOL
This attribute is only used in assocation with the "tab" attribute. Tabs found in Java literals are protected from changes by this filter.
Returns: true if whitespace in Java character and string literals is ignored.
Returns: values:
Returns: the length of tab in spaces
Returns: the next character in the resulting stream, or -1 if the end of the resulting stream has been reached.
Throws: IOException if the underlying stream throws an IOException during reading.
Parameters: attr
valid values:
Parameters: attr
valid values:
Parameters: fixlast if true a missing EOL will be appended.
Parameters: javafiles set to true to prevent this filter from changing tabs found in Java literals.
Parameters: attr
valid values:
Parameters: tabLength specify the length of tab in spaces. Valid values are between 2 and 80 inclusive. The default for this parameter is 8.
Throws: IOException on error.